You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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
The text was updated successfully, but these errors were encountered:
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
The text was updated successfully, but these errors were encountered: