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

docs: updated sphinx doc starter pack #1041

Merged
merged 6 commits into from
Jul 5, 2024
Merged

Conversation

jibel
Copy link
Collaborator

@jibel jibel commented Jul 4, 2024

Updated to tip of main.
Disabled some links that don't exist for adsys.
Fixes to the title so it fits the width of the left menu and fixed address of the documentation site for ogp.

@jibel jibel requested a review from a team as a code owner July 4, 2024 16:00
Updated to tip of main.
Disabled some links that don't exist for adsys.
Fixes to the title so it fits the width of the left menu and fixed
address of the documentation site for ogp.
fixed docs path in build python script
@codecov-commenter
Copy link

codecov-commenter commented Jul 4, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 93.80%. Comparing base (a98208e) to head (379e483).

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1041   +/-   ##
=======================================
  Coverage   93.80%   93.80%           
=======================================
  Files          79       79           
  Lines        6881     6881           
=======================================
  Hits         6455     6455           
  Misses        416      416           
  Partials       10       10           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@jibel jibel force-pushed the sphinx_docs_update_starter_pack branch from 3c98c86 to d7f2ce0 Compare July 4, 2024 16:25
It expects the config to be in the same directory
Reverse spelling to en_US
@jibel jibel force-pushed the sphinx_docs_update_starter_pack branch from 780cf1e to e6bf546 Compare July 4, 2024 16:48
@jibel jibel marked this pull request as draft July 5, 2024 07:48
build_requirements.py expects requirements.txt to be at the certain
location. Since the documentation is in a subdirectory, it is not where
build_requirements.py would like it to be (missing ./docs)
We build the path of requirements.txt dynamically so it is always in the
same directory than the python script.
@jibel jibel force-pushed the sphinx_docs_update_starter_pack branch from fb7a2fa to 379e483 Compare July 5, 2024 08:52
@jibel jibel marked this pull request as ready for review July 5, 2024 09:00
@jibel
Copy link
Collaborator Author

jibel commented Jul 5, 2024

build is also successful on read the docs https://readthedocs.com/projects/canonical-adsys/builds/2330692/

@jibel jibel requested a review from GabrielNagy July 5, 2024 09:00
Copy link
Contributor

@GabrielNagy GabrielNagy left a comment

Choose a reason for hiding this comment

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

Awesome!

@jibel jibel merged commit b8235da into main Jul 5, 2024
5 checks passed
@jibel jibel deleted the sphinx_docs_update_starter_pack branch July 5, 2024 09:19
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