Skip to content

Commit

Permalink
fix building guidance
Browse files Browse the repository at this point in the history
  • Loading branch information
eveleighoj committed Dec 6, 2024
1 parent 3ebb1b7 commit 1673491
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 8 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/deploy-documentation.yml
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ jobs:
- name: Generate Documentation
run: |
sphinx-build -b html docs/ docs/_build
make docs
- name: Upload artifact
uses: actions/upload-pages-artifact@v1
Expand Down
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -28,3 +28,5 @@ pyrightconfig.json

# don't store html build file for docs
/docs/_build
docs/digital_land*
docs/modules.rst
12 changes: 5 additions & 7 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -40,17 +40,15 @@ endif
# install pre-commits
pre-commit install

# build docs from doc strings
.PHONY: api-docs
api-docs:
sphinx-apidoc -o docs/ api/digital_land
# Build documentation with Sphinx
# Build documentation with Sphinx use for deploying documentation
.PHONY: docs
docs: api-docs
sphinx-apidoc -o docs/ digital_land
sphinx-build -b html docs/ docs/_build

# Serve the documentation locally with live-reloading
serve-docs: api-docs
# Serve the documentation locally with live-reloading. Use this for local building
serve-docs:
sphinx-apidoc -o docs/ digital_land
sphinx-autobuild docs/ docs/_build --host 0.0.0.0 --port 8000

# Clean up the generated documentation
Expand Down

0 comments on commit 1673491

Please sign in to comment.