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

Refactor existing documentation with Sphinx #74

Closed
3 of 4 tasks
Tracked by #53
, #54
...
rszamszur opened this issue Apr 21, 2022 · 0 comments · Fixed by #83
Closed
3 of 4 tasks
Tracked by #53
, #54
...

Refactor existing documentation with Sphinx #74

rszamszur opened this issue Apr 21, 2022 · 0 comments · Fixed by #83
Assignees
@rszamszur
Labels
documentation Improvements or additions to documentation
Milestone
0.11.0

Comments

@rszamszur
Copy link
Member

rszamszur commented Apr 21, 2022 •
edited

  • I have searched the issues of this repo and believe that this is not a duplicate.

Feature Request

Refactor current documentation with Sphinx. IMHO is better for my use-case + it can generate API docs from Google docstrings.

  • Create Sphinx documentation
  • Add API reference generated from docstrings
  • Overall improve docstrings
@rszamszur rszamszur added enhancement New feature or request triage This issue needs to be triaged documentation Improvements or additions to documentation and removed enhancement New feature or request triage This issue needs to be triaged labels Apr 21, 2022
@rszamszur rszamszur added this to the 0.11.0 milestone Apr 21, 2022
@rszamszur rszamszur self-assigned this Apr 21, 2022
@rszamszur rszamszur changed the title Add Sphinx docs Refactor existing documentation with Sphinx Apr 21, 2022
This was referenced Apr 21, 2022
Closed
Closed
Open
Merged
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@rszamszur rszamszur

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
0.11.0
Development

Successfully merging a pull request may close this issue.

Add sphinx docs fastapi-mvc/fastapi-mvc
1 participant
@rszamszur