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

feat(docs): migrate to sphinx 7 #553

Merged
merged 2 commits into from
Jun 14, 2024
Merged

feat(docs): migrate to sphinx 7 #553

merged 2 commits into from
Jun 14, 2024

Conversation

Rotzbua
Copy link
Contributor

@Rotzbua Rotzbua commented Jun 12, 2024

Changes

feat(docs): migrate to sphinx 7
feat(docs): add instant search
feat(docs): enable reproducible build with requirements.txt
fix(docs): warnings
WARNING: The pre-Sphinx 1.0 'intersphinx_mapping' format is deprecated and will be removed in Sphinx 8. Update to the current format as described in the documentation. Hint: "intersphinx_mapping = {'': ('https://docs.python.org/', None)}".https://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html#confval-intersphinx_mapping

Source

Template created by sphinx-quickstart

Reference

(should) fix #554

feat(docs): add instant search
feat(docs): enable reproducible build with requirements.txt
fix(docs): warnings
WARNING: The pre-Sphinx 1.0 'intersphinx_mapping' format is deprecated and will be removed in Sphinx 8. Update to the current format as described in the documentation. Hint: "intersphinx_mapping = {'<name>': ('https://docs.python.org/', None)}".https://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html#confval-intersphinx_mapping
Copy link

codecov bot commented Jun 12, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 90.24%. Comparing base (ef24fcb) to head (5d27051).
Report is 10 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master     #553      +/-   ##
==========================================
+ Coverage   89.92%   90.24%   +0.32%     
==========================================
  Files          31       31              
  Lines        1032     1056      +24     
  Branches      104      158      +54     
==========================================
+ Hits          928      953      +25     
+ Misses         69       68       -1     
  Partials       35       35              

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

@Mogost
Copy link
Member

Mogost commented Jun 13, 2024

@Rotzbua Could you please also add a workflow for testing the doc?
Something like:

jobs:
  docs:
    runs-on: ubuntu-20.04
    name: docs
    steps:
      - name: Checkout
        uses: actions/checkout@v4
      - name: Set up Python
        uses: actions/setup-python@v5
        with:
          python-version: '3.12'
          cache: 'pip'
          cache-dependency-path: 'docs/requirements.txt'
      - run: python -m pip install -r docs/requirements.txt
      - name: Build docs
        run: |
          cd docs
          sphinx-build .........

@Rotzbua
Copy link
Contributor Author

Rotzbua commented Jun 13, 2024

Seems RTD offers a option to build a preview for PRs. Would a preview perhaps be better for a maintainer? @Mogost What is your opinion?
https://docs.readthedocs.io/en/stable/pull-requests.html

@Mogost
Copy link
Member

Mogost commented Jun 14, 2024

Seems RTD offers a option to build a preview for PRs. Would a preview perhaps be better for a maintainer? @Mogost What is your opinion? docs.readthedocs.io/en/stable/pull-requests.html

This would be better. But for this, we need somebody with access to the readthedocs. Am I right?
If so I don't know who is the owner of the account. Probably @jezdez

@Mogost
Copy link
Member

Mogost commented Jun 14, 2024

Thank you

@Mogost Mogost merged commit 6976d8a into jazzband:master Jun 14, 2024
8 checks passed
@Mogost
Copy link
Member

Mogost commented Jun 14, 2024

The doc build was successful https://readthedocs.org/projects/django-constance/builds/24696890/

@Rotzbua Rotzbua deleted the fix_doc branch June 14, 2024 16:50
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.

RTD/docs build fails
2 participants