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

Make documentation compatible with Sphinx #5

Open
ziyadedher opened this issue Nov 17, 2019 · 0 comments
Open

Make documentation compatible with Sphinx #5

ziyadedher opened this issue Nov 17, 2019 · 0 comments
Assignees
@ziyadedher
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good issue for anyone new to the repository
Milestone
v0.1

Comments

@ziyadedher
Copy link
Owner

Is your feature request related to a problem? Please describe.
Having a documentation tool be able to parse the project and generate extensive documentation would be a great plus.

Describe the solution you'd like
Refactor the documentation to follow the Sphinx documentation guidelines in order to have the documentation generation be as effective as possible.

Describe alternatives you've considered
We can try other documentation generation tools, but Sphinx seems to be the most popular at the moment.
@ziyadedher ziyadedher added documentation Improvements or additions to documentation enhancement New feature or request labels Nov 17, 2019
@ziyadedher ziyadedher self-assigned this Nov 17, 2019
@ziyadedher ziyadedher added this to the Initial Release Ready milestone Nov 17, 2019
@ziyadedher ziyadedher added the good first issue Good issue for anyone new to the repository label Nov 17, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@ziyadedher ziyadedher

Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good issue for anyone new to the repository
Projects
None yet
Milestone
v0.1
Development

No branches or pull requests
1 participant
@ziyadedher