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

Update Sphinx documentation #532

Merged
merged 3 commits into from
Jul 26, 2023

Conversation

xDaile
Copy link
Contributor

@xDaile xDaile commented Jul 13, 2023

The celery was not compatible with Sphinx >=6.2.0 because of this issue (celery/celery#7978). As the new version of celery, compatible with Sphinx > 6.2.0 was released, we need to update the outdated documentation.

Currently, the Sphinx library has available a newer version 7.0.1 instead of 6.2.1, however, this version is not compatible with the sphinx-rtd-theme as mentioned in (readthedocs/sphinx_rtd_theme#1463), so we need to stick to 6.2.1 for now.

  • Documentation to new modules was added.
  • docs/requeirements.txt was reordered and updated with opentelementry packages
  • Added workflow job for building the docs in Github CI/CD

Additionally /web/static/api_v1.yaml was updated.

@xDaile xDaile force-pushed the update_sphinx_documentation branch from 93b4ea0 to 9bd97b6 Compare July 13, 2023 10:23
@yashvardhannanavati yashvardhannanavati force-pushed the update_sphinx_documentation branch from 9bd97b6 to d9066d2 Compare July 13, 2023 19:09
@xDaile xDaile force-pushed the update_sphinx_documentation branch from d9066d2 to 320cf31 Compare July 13, 2023 20:04
@xDaile xDaile changed the title Update Sphinx documentation [Draft] Update Sphinx documentation Jul 13, 2023
@xDaile xDaile changed the title [Draft] Update Sphinx documentation Update Sphinx documentation Jul 14, 2023
@yashvardhannanavati yashvardhannanavati force-pushed the update_sphinx_documentation branch from 535420f to 4999a3c Compare July 17, 2023 18:30
lipoja
lipoja previously approved these changes Jul 18, 2023
@xDaile xDaile changed the title Update Sphinx documentation [Draft] Update Sphinx documentation Jul 18, 2023
@xDaile xDaile force-pushed the update_sphinx_documentation branch from 022e4c4 to d15d12c Compare July 18, 2023 17:38
@xDaile xDaile changed the title [Draft] Update Sphinx documentation Update Sphinx documentation Jul 18, 2023
@xDaile xDaile requested a review from lipoja July 18, 2023 17:46
lipoja
lipoja previously approved these changes Jul 19, 2023
@xDaile xDaile force-pushed the update_sphinx_documentation branch from d15d12c to 5c3c8b5 Compare July 19, 2023 07:49
lipoja
lipoja previously approved these changes Jul 19, 2023
@yashvardhannanavati yashvardhannanavati force-pushed the update_sphinx_documentation branch from 6578b84 to 7ce1af0 Compare July 24, 2023 22:04
@xDaile xDaile force-pushed the update_sphinx_documentation branch from 7ce1af0 to f19c34e Compare July 26, 2023 07:43
@xDaile xDaile merged commit b18f155 into release-engineering:master Jul 26, 2023
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.

4 participants