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.

Sign up for GitHub

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

Jump to bottom

Improve api documentation #526

Closed
dancergraham opened this issue Nov 15, 2024 · 3 comments · Fixed by #539
Closed

Improve api documentation #526

dancergraham opened this issue Nov 15, 2024 · 3 comments · Fixed by #539
Assignees
@dancergraham
Labels
docs-wanted good-first-bug

Comments

@dancergraham
Copy link
Contributor

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
@Yadavanurag13
Copy link

@dancergraham I would like to pick this issue.

@dancergraham
Copy link
Contributor Author

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
@dancergraham
WIP - Test the docs
9398713 
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 dancergraham mentioned this issue Nov 26, 2024
Merged
@Yadavanurag13
Copy link

@dancergraham Hi, I'm currently busy with a task and unable to contribute this time, so I will unassign myself.

@Yadavanurag13 Yadavanurag13 removed their assignment Dec 1, 2024
@dancergraham dancergraham self-assigned this Dec 2, 2024
dancergraham added a commit to dancergraham/django-waffle that referenced this issue Dec 4, 2024
@dancergraham
WIP - Test the docs
298418f 
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 added a commit that referenced this issue Dec 28, 2024
@dancergraham
Test all pull requests for docs (#536)
7f0d532 
* WIP - Test the docs

Related to #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.

* refactor: simplify changes

* refactor: undo changes to run.sh
@dancergraham dancergraham linked a pull request Dec 28, 2024 that will close this issue
Docs improve api docs #539
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@dancergraham dancergraham

Labels
docs-wanted good-first-bug
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Docs improve api docs dancergraham/django-waffle
2 participants
@dancergraham @Yadavanurag13