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

Documentation for Skyplane #250

Merged
merged 7 commits into from
Apr 14, 2022
Merged

Documentation for Skyplane #250

merged 7 commits into from
Apr 14, 2022

Conversation

parasj
Copy link
Contributor

@parasj parasj commented Apr 6, 2022

This PR adds documentation in Spinx/ReadTheDocs format.

To build, run:

$ pip install sphinx-autobuild
$ sphinx-autobuild -b html docs docs/_build

@parasj parasj added the documentation Improvements or additions to documentation label Apr 6, 2022
@parasj parasj self-assigned this Apr 6, 2022
@parasj
Copy link
Contributor Author

parasj commented Apr 7, 2022

Useful page with quickstart for docs https://www.sphinx-doc.org/en/master/usage/quickstart.html

@parasj parasj added the draft label Apr 7, 2022
@parasj parasj changed the title [Draft] Documentation for Skyplane Documentation for Skyplane Apr 13, 2022
@parasj
Copy link
Contributor Author

parasj commented Apr 14, 2022

Consider automatically building and pushing changes to documentation to a gh-pages branch: https://github.com/ammaraskar/sphinx-action

@parasj parasj merged commit 3d0cb8b into main Apr 14, 2022
@parasj parasj deleted the dev/paras/docs branch April 14, 2022 22:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation draft
Projects
No open projects
Status: Done
Development

Successfully merging this pull request may close these issues.

1 participant