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

Add sphinx docs #79

Merged
merged 10 commits into from
Nov 7, 2023
Merged

Add sphinx docs #79

merged 10 commits into from
Nov 7, 2023

Conversation

Lee-W
Copy link
Collaborator

@Lee-W Lee-W commented Nov 3, 2023 •
edited

圖片
  • initialize sphinx with myst extension for markdown support
  • consolidate all documentation into docs
  • add build-docs, serve-docs tasks

Close: #81

@cloudflare-pages Cloudflare Pages
Copy link

cloudflare-pages bot commented Nov 3, 2023 •
edited

Deploying with  Cloudflare Pages  Cloudflare Pages

Latest commit: 350a2b5
Status: ✅  Deploy successful!
Preview URL: https://de93f05f.ask-astro.pages.dev
Branch Preview URL: https://add-sphinx-docs.ask-astro.pages.dev

View logs

@Lee-W
Copy link
Collaborator Author

Lee-W commented Nov 3, 2023

Still needs some modification. but it roughly looks like this now
image

@Lee-W Lee-W self-assigned this Nov 3, 2023
@Lee-W Lee-W added this to the 0.1.0 milestone Nov 3, 2023
@Lee-W Lee-W marked this pull request as ready for review November 6, 2023 10:02
sunank200
sunank200 approved these changes Nov 6, 2023
View reviewed changes
Copy link
Collaborator

@sunank200 sunank200 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you add the docs around how to build the docs and use it please? Rest of it LGTM

@Lee-W
Copy link
Collaborator Author

Lee-W commented Nov 7, 2023

Can you add the docs around how to build the docs and use it please? Rest of it LGTM

just updated. please take a look. thanks!

@sunank200 sunank200 merged commit 4c92922 into main Nov 7, 2023
4 checks passed
@sunank200 sunank200 deleted the add-sphinx-docs branch November 7, 2023 05:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sunank200 sunank200 sunank200 approved these changes

@pankajastro pankajastro Awaiting requested review from pankajastro pankajastro is a code owner

Assignees

@Lee-W Lee-W

Labels
None yet
Projects
None yet
Milestone
0.1.0
Development

Successfully merging this pull request may close these issues.

Setup sphinx documentation
2 participants
@Lee-W @sunank200