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.

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

Edit Sphinx generated documentation format #15

Open
debeshmandal opened this issue Oct 21, 2020 · 0 comments
Open

Edit Sphinx generated documentation format #15

debeshmandal opened this issue Oct 21, 2020 · 0 comments
Labels
deploy Everything related to CI and deployment documentation Improvements or additions to documentation
Milestone

Comments

@debeshmandal
Copy link
Member

Documentation is generated using Sphinx. This is deployed using CI. The format of this is not ideal and the information could be rearranged.

To do this, we can edit the *.rst files in the docs/ folder and also the conf.py file found there.

To test the new view, a user can manually do the following:

cd docs
make html

And then open the result in their web browser.

This issue (and related pull request) are to be used to experiment with this appearance.

@debeshmandal debeshmandal added documentation Improvements or additions to documentation deploy Everything related to CI and deployment labels Oct 21, 2020
@debeshmandal debeshmandal added this to the v1.2.0 milestone Oct 21, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
deploy Everything related to CI and deployment documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant