Skip to content

Conversation

@RKrahl
Copy link
Owner

@RKrahl RKrahl commented Nov 26, 2023

Add documentation.

Note: this is not yet done, hence this is a draft PR. I open it now in order to structure the work and to formulate a task list:

  • Setup the build environment for the documentation,
  • Write an introduction including an explanation about the project and install instructions,
  • Document the command line interface, e.g. man pages for the archive-tool and backup-tool scripts and their subcommands,
  • Document the configuration file for the backup-tool.
  • Reference documentation for the Python API,
  • Setup a RTD site,
  • Update README and setup script, including pointers to the new RTD site.

Close #7.

@RKrahl RKrahl added enhancement New feature or request documentation Improvements or additions to documentation labels Nov 26, 2023
@RKrahl RKrahl added this to the 0.7 milestone Nov 26, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add documentation

2 participants