Improve api documentation #526
Assignees
Labels
Comments
|
@dancergraham I would like to pick this issue. |
|
Great, let me know if you need any help getting started |
dancergraham
added a commit
to dancergraham/django-waffle
that referenced
this issue
Nov 26, 2024
Related to jazzband#526 Add a command to build the documentation using Sphinx and update the CI workflow to include a documentation build stage. * **run.sh** - Add a command to build the documentation using Sphinx. - Update the usage function to include the new builddocs command. * **.github/workflows/python-package.yml** - Add a new stage to run the documentation building to ensure it works. - Update the release-production stage to depend on the new docs stage.
|
@dancergraham Hi, I'm currently busy with a task and unable to contribute this time, so I will unassign myself. |
dancergraham
added a commit
to dancergraham/django-waffle
that referenced
this issue
Dec 4, 2024
Related to jazzband#526 Add a command to build the documentation using Sphinx and update the CI workflow to include a documentation build stage. * **run.sh** - Add a command to build the documentation using Sphinx. - Update the usage function to include the new builddocs command. * **.github/workflows/python-package.yml** - Add a new stage to run the documentation building to ensure it works. - Update the release-production stage to depend on the new docs stage.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
The api is only partially documented in the online docs, for instance the flags page lists attributes (but capitalises them) and does not list methods - it would be good to document the public methods
https://waffle.readthedocs.io/en/stable/types/flag.html
Switches lists neither attributes nor methods
Samples lists attributes (but capitalises them) and does not list methods
The text was updated successfully, but these errors were encountered: