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

Setup sphinx documentation #81

Closed

Tracked by

Lee-W opened this issue Nov 6, 2023 · 0 comments · Fixed by #79

Closed

Tracked by

Setup sphinx documentation #81

Lee-W opened this issue Nov 6, 2023 · 0 comments · Fixed by #79

Assignees

Milestone

Collaborator

Lee-W commented Nov 6, 2023 •

edited

Loading

Initialize sphinx project structure under docs
Consolidate current documentation and move them into docs to reduce duplication
Make pyinvoke tasks for building and serving documentation

The text was updated successfully, but these errors were encountered:

Lee-W mentioned this issue

Documentation for architecture for the deployment #45

Closed

6 tasks

Lee-W changed the title ~~Sphinx ??? --> (also add building docs to CI)~~ Setup sphinx documentation

Lee-W mentioned this issue

Add sphinx docs #79

Merged

Lee-W self-assigned this

Lee-W added this to the 0.1.0 milestone

sunank200 closed this as completed in #79

sunank200 pushed a commit that referenced this issue


          Add sphinx docs (#79)

4c92922

<img width="1623" alt="圖片"
src="https://github.com/astronomer/ask-astro/assets/5144808/0f0e650d-8969-41ba-bc2d-28a75126b140">


* initialize sphinx with
[myst](https://myst-parser.readthedocs.io/en/latest/index.html)
extension for markdown support
* consolidate all documentation into `docs`
* add `build-docs`, `serve-docs` tasks

Close: #81

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment