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

Structuring Documentation, setting a standard for documenting on functions, documentation hosted online #79

Open
GijsGroote opened this issue Apr 16, 2022 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@GijsGroote
Copy link
Collaborator

Documentation should receive a review on the structure.
ATM it contains "introduction" and "getting_started", if done okey this would not be an issue, but it contains redundant information.
All the functional documentation is in "developers.rst" and "introduction.rst", which are not self explaining names.

What best standard can be used to explain a function in the docs? And how to add extra info to functions when generated automatically

Generating the site .html pages offline works. But hosting online lowers the threshold to use the docs.

Additionally, the README.md at the root of the project should link to the online documentation

@GijsGroote GijsGroote added the documentation Improvements or additions to documentation label Apr 16, 2022
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
Projects
None yet
Development

No branches or pull requests

1 participant