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

Use a YAML file and Python requirements #52

Merged
merged 1 commit into from
Aug 16, 2023

Conversation

humitos
Copy link
Member

@humitos humitos commented Aug 16, 2023

The .readthedocs.yaml file is now required.

Besdies, we are not installing the Read the Docs Sphinx theme by default. Due to that, we need to manually install it via requirements.txt

@humitos humitos force-pushed the humitos/config-requirements branch 2 times, most recently from 6d7ea91 to 74d2bb2 Compare August 16, 2023 14:53
humitos added a commit to readthedocs/readthedocs.org that referenced this pull request 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"

* Related: #10626 (comment)
* Requires: readthedocs/tutorial-template#52
humitos added a commit to readthedocs/readthedocs.org that referenced this pull request 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"

* Related: #10626 (comment)
* Requires: readthedocs/tutorial-template#52
The `.readthedocs.yaml` file is now required.

Besdies, we are not installing the Read the Docs Sphinx theme by default.
Due to that, we need to manually install it via `requirements.txt`
@humitos humitos force-pushed the humitos/config-requirements branch from 74d2bb2 to 4dc7417 Compare August 16, 2023 15:17
@ericholscher ericholscher merged commit 00dc2a7 into main Aug 16, 2023
@ericholscher ericholscher deleted the humitos/config-requirements branch August 16, 2023 18:07
humitos added a commit to readthedocs/readthedocs.org that referenced this pull request Aug 17, 2023
* Docs: update tutorial with the latest required changes

- `.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

* Docs: update screenshot

* Docs: the page is called Admin

* Docs: remove note about requiring a YAML file
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.

3 participants