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 readthedocs and CI job for checking documentation building #93

Merged
merged 4 commits into from
Nov 14, 2023

Conversation

Lee-W
Copy link
Collaborator

@Lee-W Lee-W commented Nov 8, 2023

  • circleci
    • add build-docs step for check doc building process
    • use python 3.11 for consistency
  • readthedocs
    • add readthedocs config

close #94

Copy link

cloudflare-workers-and-pages bot commented Nov 8, 2023

Deploying with  Cloudflare Pages  Cloudflare Pages

Latest commit: 118745d
Status: ✅  Deploy successful!
Preview URL: https://6466207d.ask-astro.pages.dev
Branch Preview URL: https://setup-docs-ci.ask-astro.pages.dev

View logs

@Lee-W Lee-W force-pushed the setup-docs-ci branch 2 times, most recently from 7aea6fc to bdb9922 Compare November 8, 2023 10:05
@Lee-W
Copy link
Collaborator Author

Lee-W commented Nov 8, 2023

According to build, it seems as if we already connect to the readthedocs, it will build for us automatically. @sunank200 Do you know who have the access to read the dashboard so that we can check? Thanks!

@Lee-W Lee-W changed the title Setup docs ci Setup readthedocs and CI job for checking documentation building Nov 8, 2023
@sunank200
Copy link
Collaborator

According to build, it seems as if we already connect to the readthedocs, it will build for us automatically. @sunank200 Do you know who have the access to read the dashboard so that we can check? Thanks!

Do we need to build this for readthedocs now?

@Lee-W
Copy link
Collaborator Author

Lee-W commented Nov 9, 2023

not really, more like a nice to have and GitHub pages would be another option that's easier to setup

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.

We should use GitHub Pages instead here @Lee-W

Copy link
Collaborator

@pankajastro pankajastro left a comment

Choose a reason for hiding this comment

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

LGTM

@pankajastro
Copy link
Collaborator

@sunank200 do you want to hold for #93 (review) or we should merge it or wdyt?

@pankajastro pankajastro mentioned this pull request Nov 14, 2023
@pankajastro
Copy link
Collaborator

@sunank200 do you want to hold for #93 (review) or we should merge it or wdyt?

created GH issue #122 to track it

@pankajastro pankajastro merged commit a3c3d00 into main Nov 14, 2023
8 checks passed
@pankajastro pankajastro deleted the setup-docs-ci branch November 14, 2023 10:14
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 readthedocs
3 participants