Skip to content

Docs: Update tutorial and repo with .readthedocs.yaml #10454

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

Closed
3 tasks
benjaoming opened this issue Jun 21, 2023 · 1 comment · Fixed by #10639
Closed
3 tasks

Docs: Update tutorial and repo with .readthedocs.yaml #10454

benjaoming opened this issue Jun 21, 2023 · 1 comment · Fixed by #10639
Assignees

Comments

@benjaoming
Copy link
Contributor

benjaoming commented Jun 21, 2023

As part of #10351, we are updating the tutorial:

  • Add a .readthedocs.yaml to the tutorial template repo (let's keep it aligned with our how-to example template for Sphinx)
  • Remove the part of the guide that suggests to create one
  • Adapt the section about the configuration file: "Manage your configuration with .readthedocs.yaml" or similar

Also useful:

Related:

@benjaoming
Copy link
Contributor Author

The current tutorial is using a layout with docs/source separated. It's pretty unconventional and means we would have to have a variation in the example .readthedocs.yaml for the tutorial.

I would like the tutorial to align with the more popular convention of not having a separate Sphinx source dir, such as docs/source so we don't need to also spill this into the example .readthedocs.yaml, but we can move forwards with a consistency throughout our docs and website UI.

@ericholscher ericholscher self-assigned this Aug 2, 2023
@ericholscher ericholscher moved this from Planned to In progress in 📍Roadmap Aug 16, 2023
@github-project-automation github-project-automation bot moved this from In progress to Done in 📍Roadmap Aug 17, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

2 participants