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

Setup sphinx docs #140

Closed
wants to merge 8 commits into from
Closed

Setup sphinx docs #140

wants to merge 8 commits into from

Conversation

fyliu
Copy link
Member

@fyliu fyliu commented Mar 15, 2023

Install sphinx and fix existing docs to look good in it.
Setup gh-workflow to generate documentation in gh-pages.

The generated docs should look exactly like this link

fyliu added 2 commits March 13, 2023 15:41
cd docs
poetry shell
poetry install
sphinx-quickstart .
/# adjust project info
/# switch to furo theme
/# set up sphinx-autobuild
/# setup myst-parser
@fyliu fyliu marked this pull request as draft March 16, 2023 22:58
@fyliu fyliu force-pushed the sphinx-docs branch 2 times, most recently from 4229238 to 8e5db1d Compare March 18, 2023 05:05
@fyliu fyliu marked this pull request as ready for review March 18, 2023 05:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Setup sphinx for documentation
2 participants