Skip to content

Docs: update tutorial with the latest required changes #10639

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

Merged
merged 4 commits into from
Aug 17, 2023

Conversation

humitos
Copy link
Member

@humitos humitos commented Aug 16, 2023

  • .readthedocs.yaml config file is now required
  • sphinx-rtd-theme is a required dependency and has to be installed via python.install.requirements
  • remove invalid options from "Import Project" page
  • comment out section about "Show warning banner"

We still need to update some of the images.


📚 Documentation previews 📚

@humitos humitos requested a review from a team as a code owner August 16, 2023 15:10
@humitos humitos requested a review from ericholscher August 16, 2023 15:10
- `.readthedocs.yaml` config file is now required
- `sphinx-rtd-theme` is a required dependency and has to be installed via
  `python.install.requirements`
- remove invalid options from "Import Project" page
- comment out section about "Show warning banner"

* Related: #10626 (comment)
* Requires: readthedocs/tutorial-template#52
@humitos humitos force-pushed the humitos/tutorial-updates branch from 4151881 to 024ad4c Compare August 16, 2023 15:16
@humitos
Copy link
Member Author

humitos commented Aug 16, 2023

Copy link
Member

@ericholscher ericholscher left a comment

Choose a reason for hiding this comment

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

This is a solid improvement, thanks for taking it on!

@humitos humitos enabled auto-merge (squash) August 17, 2023 13:48
@humitos humitos merged commit 1b8ef25 into main Aug 17, 2023
@humitos humitos deleted the humitos/tutorial-updates branch August 17, 2023 14:08
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.

Docs: Update tutorial and repo with .readthedocs.yaml
2 participants