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

Stabilize sphinx build on RTD #899

Merged
merged 9 commits into from Jul 12, 2023
Merged

Stabilize sphinx build on RTD #899

merged 9 commits into from Jul 12, 2023

Conversation

cderici
Copy link
Member

@cderici cderici commented Jul 7, 2023

Description

This is a follow up on #871 , attempting to have stable green RTD builds for generating the pylibjuju docs.

  • It adds a tox environment to run the sphinx-build locally rather then doing it in the main dev environment.
  • It adds a new .readthedocs.yaml configuration file (which will be required it looks like by Sep 2023)

Notes & Discussion

After the RTD side is stabilized, the actual docs will be revised to keep up-to-date docs for pylibjuju.

@cderici cderici added the docs label Jul 7, 2023
@cderici cderici added the backward port to be backward ported label Jul 10, 2023
As it turns out that the sphinx >=6.x doesn't play well with
coroutines.
@cderici
Copy link
Member Author

cderici commented Jul 10, 2023

/build

@cderici cderici requested a review from jack-w-shaw July 11, 2023 14:53
@cderici
Copy link
Member Author

cderici commented Jul 12, 2023

/merge

@jujubot jujubot merged commit 112bfc6 into juju:master Jul 12, 2023
6 of 8 checks passed
jujubot added a commit that referenced this pull request Jul 19, 2023
#911

#### Description

This backports the changes from #899 into the `2.9` branch to have the docs be built successfully for the `2.9` PRs and releases.

#### QA Steps

The `docs` step down in the github actions from the readthedocs should be successfully building.
@cderici cderici removed the backward port to be backward ported label Jul 19, 2023
jujubot added a commit that referenced this pull request Jul 20, 2023
#920

## What's Changed
* Update readme and add some docstrings for functions by @cderici in #873
* Forward port subordinate utils by @cderici in #880
* [JUJU-3952] Revisit access control levels by @cderici in #882
* [JUJU-3999] Avoid parsing endpoint for overlay offers by @cderici in #887
* Forward port upgrade resource fixes in app refresh by @cderici in #889
* [JUJU-4076] Rename `wait_for_units` and make semantics clearer by @cderici in #890
* Stabilize sphinx build on RTD by @cderici in #899
* Move test utils into a separate module by @cderici in #903
* Remove title prefixes from issue templates by @cderici in #904
* [JUJU-4048] Use GetChangesMapArgs for bundle changes by @jack-w-shaw in #907
* Forward ports from 2.9 to 3.x by @cderici in #910
* Remove ceiling on pyyaml version by @cderici in #918

[JUJU-3952]: https://warthogs.atlassian.net/browse/JUJU-3952?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ
[JUJU-3999]: https://warthogs.atlassian.net/browse/JUJU-3999?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ
[JUJU-4076]: https://warthogs.atlassian.net/browse/JUJU-4076?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ
[JUJU-4048]: https://warthogs.atlassian.net/browse/JUJU-4048?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants