Skip to content

docs: Parameterize READTHEDOCS_VERSION#11840

Merged
borkmann merged 1 commit intocilium:masterfrom
joestringer:submit/parameterize-rtd-version
Jun 3, 2020
Merged

docs: Parameterize READTHEDOCS_VERSION#11840
borkmann merged 1 commit intocilium:masterfrom
joestringer:submit/parameterize-rtd-version

Conversation

@joestringer
Copy link
Copy Markdown
Member

@joestringer joestringer commented Jun 2, 2020 •
edited
Loading

This way you can specify it on the commandline to generate docs in the
way that RTD would by passing the environment variable, eg:

$ READTHEDOCS_VERSION="v1.8.0-rc2" make render-docs

@joestringer
docs: Parameterize READTHEDOCS_VERSION
60f8042 
This way you can specify it on the commandline to generate docs in the
way that RTD would by passing the environment variable, eg:

  $ READTHEDOCS_VERSION="v1.8.0-rc2" make render-docs

Signed-off-by: Joe Stringer <joe@cilium.io>
@joestringer joestringer added area/documentation Impacts the documentation, including textual changes, sphinx, or other doc generation code. release-note/misc This PR makes changes that have no direct user impact. needs-backport/1.8 labels Jun 2, 2020
@joestringer joestringer requested a review from a team as a code owner June 2, 2020 21:33
michi-covalent
michi-covalent approved these changes Jun 2, 2020
View reviewed changes
Copy link
Copy Markdown
Contributor

@michi-covalent michi-covalent left a comment

Choose a reason for hiding this comment

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

just curious what happens when i run make render-docs without specifying READTHEDOCS_VERSION?

@coveralls
Copy link
Copy Markdown

coveralls commented Jun 2, 2020

Coverage Status

Coverage decreased (-0.04%) to 36.891% when pulling 60f8042 on joestringer:submit/parameterize-rtd-version into e7701f5 on cilium:master.

@joestringer
Copy link
Copy Markdown
Member Author

joestringer commented Jun 2, 2020 •
edited
Loading

@michi-covalent If you run without, it will generate the install instructions that say to download the zip file of the Helm charts from github, then template/install from there.

If you specify the READTHEDOCS_VERSION then you can generate the docs closer to how RTD would, ie the install instructions will tell you to add the Helm repo and to pull the charts from there using the version that you specify in the variable.

@borkmann borkmann merged commit d4a968e into cilium:master Jun 3, 2020
@tklauser tklauser mentioned this pull request Jun 3, 2020
Merged
@joestringer joestringer deleted the submit/parameterize-rtd-version branch June 4, 2020 04:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@michi-covalent michi-covalent michi-covalent approved these changes

Assignees

No one assigned

Labels

area/documentation Impacts the documentation, including textual changes, sphinx, or other doc generation code. release-note/misc This PR makes changes that have no direct user impact.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@joestringer @coveralls @michi-covalent @tklauser @borkmann