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

Pin Sphinx < 7 and build without setuptools hook #549

Merged
merged 2 commits into from
Jun 16, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 7 additions & 10 deletions .github/workflows/subscript.yml
Original file line number Diff line number Diff line change
Expand Up @@ -26,15 +26,12 @@ jobs:

steps:
- name: Checkout commit locally
uses: actions/checkout@v2

- name: Checkout tags
# This seems necessary for setuptools_scm to be able to infer
# the correct version.
run: git fetch --unshallow --tags

uses: actions/checkout@v3
with:
fetch-depth: 0

- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v1
uses: actions/setup-python@v4
with:
python-version: ${{ matrix.python-version }}

Expand Down Expand Up @@ -78,12 +75,12 @@ jobs:
run: rstcheck -r docs

- name: Build documentation
run: python setup.py build_sphinx
run: sphinx-build -b html docs build/docs/html

- name: Update GitHub pages
if: github.repository_owner == 'equinor' && github.ref == 'refs/heads/master' && matrix.python-version == '3.8'
run: |
cp -R ./build/sphinx/html ../html
cp -R ./build/docs/html ../html

git config --local user.email "subscript-github-action"
git config --local user.name "subscript-github-action"
Expand Down
2 changes: 1 addition & 1 deletion docs/contribution.rst
Original file line number Diff line number Diff line change
Expand Up @@ -144,6 +144,6 @@ Building documentation
Assuming the developer instructions above, run the following command to to
build the documentation for subscript::

python setup.py build_sphinx
sphinx-build -b html docs build/docs/html

and then point your browser to the file ``build/docs/index.html``.
2 changes: 1 addition & 1 deletion docs_requirements.txt
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
autoapi
sphinx
sphinx<7
sphinx-argparse
sphinx-autodoc-typehints
sphinx_rtd_theme