Skip to content

Speed up quartodoc build by removing individual table documentation #117

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.

Sign up for GitHub

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

Open
Copilot wants to merge 5 commits into
base: main
Choose a base branch
from
Open

Speed up quartodoc build by removing individual table documentation #117

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
59f106c
Initial plan
Copilot Feb 24, 2026
4980d35
Speed up quartodoc build by removing include_inherited and limiting T…
Copilot Feb 24, 2026
acc84a4
Add Base Table Classes section to document inherited methods centrally
Copilot Feb 24, 2026
293cb5c
Pin griffe<2 to fix quartodoc 0.10.0 compatibility
Copilot Feb 25, 2026
f651e8a
Remove individual table documentation, update docs workflow and DEVEL…
Copilot Feb 26, 2026
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
20 changes: 14 additions & 6 deletions .github/workflows/docs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,20 +13,28 @@ jobs:
runs-on: windows-latest

steps:
- uses: actions/checkout@v2
- uses: actions/checkout@v4
- name: Set up Python
uses: actions/setup-python@v4
uses: actions/setup-python@v5
with:
python-version: "3.12"

- name: Install Quarto
uses: quarto-dev/quarto-actions/setup@v2

- name: Install mikeplus
run: pip install .[dev]
run: pip install .[docs]

- name: MkDocs
run: mkdocs build
- name: Build API docs
working-directory: docs
run: quartodoc build

- name: Render site
working-directory: docs
run: quarto render

- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: site
publish_dir: docs/_site
6 changes: 1 addition & 5 deletions DEVELOPMENT.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,6 @@ When a new version of MIKE+ is released, the following needs to be done before r
9. Bump package version to match year of MIKE+ (e.g. 2026.0.0 for the first 2026 release)
10. Update CI runner to use the new MIKE+ version
11. Do other changes associated with a standard MIKE+Py release that does not involve bumping MIKE+ versions.
12. Update auto generated table documentation.
- `uv run .\docs\generate_table_docs.py`
- Review the diff in `docs/_table_generated_sections.yml`. It may be the same, or include new or removed tables.
Note that the above list is a guideline and may not be exaustive. Automation of these steps is welcome - consider the current process best efforts.

## Documentation
Expand All @@ -32,8 +29,7 @@ To build the documentation locally, follow these steps:

1. Install quarto
2. Run the following from `docs` as the root:
- `uv run quartodoc build` ... if this seems to hang, use the `--verbose` flag, it's just really slow due to auto generated tables.
- `uv run quartodoc build`
- `uv run quarto render`
... wip


Loading