Skip to content

Commit

Permalink
Build Sphinx without setuptools hook
Browse files Browse the repository at this point in the history
  • Loading branch information
mferrera committed Jun 16, 2023
1 parent 956a0a2 commit c5464fe
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 11 deletions.
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``.

0 comments on commit c5464fe

Please sign in to comment.