Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add documentation #63

Draft
wants to merge 22 commits into
base: develop
Choose a base branch
from
Draft

Add documentation #63

wants to merge 22 commits into from

Conversation

RKrahl
Copy link
Owner

@RKrahl RKrahl commented Sep 30, 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 photo-idx script and its subcommands,
  • Document the GUI,
  • Reference documentation for the Python API,
  • Setup a RTD site,
  • Update README and setup script, including pointers to the new RTD site.

Close #2.

@RKrahl RKrahl added enhancement New feature or request documentation Improvements or additions to documentation labels Sep 30, 2023
@RKrahl RKrahl added this to the 0.11 milestone Sep 30, 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.
1 participant