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

try instal test of project #277

Merged
merged 9 commits into from
Dec 6, 2024
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
9 changes: 5 additions & 4 deletions .github/workflows/deploy-documentation.yml
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,9 @@ jobs:

steps:
- name: Checkout code
uses: actions/checkout@v3
uses: actions/checkout@v4
with:
fetch-depth: 0

- name: Set up Python
uses: actions/setup-python@v4
Expand All @@ -32,12 +34,11 @@ jobs:

- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install sphinx sphinx-autobuild sphinx_rtd_theme
make init

- 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
14 changes: 6 additions & 8 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
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
21 changes: 0 additions & 21 deletions docs/digital_land.adapter.rst

This file was deleted.

141 changes: 0 additions & 141 deletions docs/digital_land.datatype.rst

This file was deleted.

37 changes: 0 additions & 37 deletions docs/digital_land.expectations.checkpoints.rst

This file was deleted.

61 changes: 0 additions & 61 deletions docs/digital_land.expectations.rst

This file was deleted.

53 changes: 0 additions & 53 deletions docs/digital_land.package.rst

This file was deleted.

Loading
Loading