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

New Read the Docs tutorial, part II #8473

Merged
merged 23 commits into from
Sep 16, 2021
Merged

Conversation

astrojuanlu
Copy link
Contributor

@astrojuanlu astrojuanlu commented Sep 7, 2021

This is the second pull request for the new Read the Docs tutorial proposed in #8106 in the context of the CZI grant. It is a follow up to #8428.

Rendered version: https://docs--8473.org.readthedocs.build/en/8473/tutorial/

This pull request intends to cover chapter 2 of the table of contents originally proposed in #8106:

  1. Customizing the build process
    • Use readthedocs.yaml (rather than the web UI) to customize build formats, change build requirements and Python version, enable fail-on-warnings
  2. Versioning documentation
    • Explain how to manage versions on RTD: create release branches, activate the corresponding version, browse them in the version selector, selectively build versions
    • Intermediate topics: hide versions, create Automation Rules

The template mentioned in the tutorial is still living on my personal GitHub account before it is accepted. I made a couple of adjustments for the tutorial.

https://github.com/astrojuanlu/tutorial-template/

docs/tutorial/index.rst Show resolved Hide resolved
docs/tutorial/index.rst Outdated Show resolved Hide resolved
Comment on lines 377 to 378
python:
version: "3.9"
Copy link
Member

Choose a reason for hiding this comment

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

Think we should put the whole content or just the new content to avoid confusions.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I think it would be a bit tedious to put all the content, and putting a fragment gives some context

@astrojuanlu astrojuanlu changed the title [WIP] New Read the Docs tutorial, part II New Read the Docs tutorial, part II Sep 8, 2021
@astrojuanlu astrojuanlu marked this pull request as ready for review September 8, 2021 14:33
@astrojuanlu
Copy link
Contributor Author

This is now ready for review.

docs/tutorial/index.rst Outdated Show resolved Hide resolved
docs/tutorial/index.rst Outdated Show resolved Hide resolved
docs/tutorial/index.rst Show resolved Hide resolved
docs/tutorial/index.rst Outdated Show resolved Hide resolved
docs/tutorial/index.rst Outdated Show resolved Hide resolved
docs/tutorial/index.rst Outdated Show resolved Hide resolved
docs/tutorial/index.rst Outdated Show resolved Hide resolved
docs/tutorial/index.rst Outdated Show resolved Hide resolved
docs/tutorial/index.rst Show resolved Hide resolved
docs/tutorial/index.rst Outdated Show resolved Hide resolved
docs/glossary.rst Outdated Show resolved Hide resolved
docs/tutorial/index.rst Outdated Show resolved Hide resolved
docs/tutorial/index.rst Outdated Show resolved Hide resolved
docs/tutorial/index.rst Outdated Show resolved Hide resolved
@astrojuanlu
Copy link
Contributor Author

Opened #8476 with some thoughts about our implicit automations for versions, although I'd prefer to not block the tutorial on it.

@astrojuanlu astrojuanlu requested a review from a team September 9, 2021 16:14
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 looks like a great addition! Just a few small things I noticed, but I think it's close.

docs/tutorial/index.rst Show resolved Hide resolved
docs/tutorial/index.rst Outdated Show resolved Hide resolved
docs/tutorial/index.rst Outdated Show resolved Hide resolved
docs/tutorial/index.rst Show resolved Hide resolved
docs/tutorial/index.rst Outdated Show resolved Hide resolved
docs/tutorial/index.rst Outdated Show resolved Hide resolved
docs/tutorial/index.rst Show resolved Hide resolved
docs/tutorial/index.rst Outdated Show resolved Hide resolved
docs/tutorial/index.rst Show resolved Hide resolved
From this point, ``1.0.x`` version is no longer the most up to date one.
To display a warning to your readers, go to the "⚙ Admin" menu of your project home,
click on the "Advanced Settings" link on the left,
enable the "Show version warning" checkbox, and click the :guilabel:`Save` button.
Copy link
Member

Choose a reason for hiding this comment

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

I think we deprecated this functionality, and replaced it with this extension, apparently without noting that anywhere: https://sphinx-version-warning.readthedocs.io/en/latest/ -- I think we did this to make it more configurable (/cc @humitos).

Not 100% sure if we should include it in the tutorial. If it works, we can go ahead and keep it in tho, unless we really don't want to promote it.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It works, I tested it with my own project and took a screenshot. If it's deprecated, it's impossible to know, because there's no mention of it in https://docs.readthedocs.io/en/stable/versions.html#version-warning either.

astrojuanlu and others added 6 commits September 15, 2021 12:41
Co-authored-by: Eric Holscher <25510+ericholscher@users.noreply.github.com>
Co-authored-by: Eric Holscher <25510+ericholscher@users.noreply.github.com>
@astrojuanlu
Copy link
Contributor Author

Thanks @ericholscher! Addressed the second round of feedback 👍🏽

@astrojuanlu
Copy link
Contributor Author

Since this is approved, I will merge and then add some changes related to our default versions and dependencies in a separate pull request. See discussion on #8473 (comment) and content in https://github.com/readthedocs/readthedocs.org/pull/7859/files#diff-1d854732c488780cf89b325277dd80220a7e541647ccf1c18bdc372eb7b1a4d6R49.

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.

None yet

3 participants