[FSTORE-1921] Improve documentation building process #532
Conversation
That is, replace ([^0-9])\. ([A-Z]) with $1.\n$2 plus process exceptions.
|
The checks fail because main of hopsworks-api is used. See https://aversey.github.io/logicalclocks.github.io/latest/ for results and https://github.com/aversey/logicalclocks.github.io/actions/runs/19969615418/job/57270781705 for the last check (the one before |
There was a problem hiding this comment.
Pull request overview
This PR improves the documentation building process by modernizing dependencies, introducing new documentation tools, and standardizing markdown formatting across documentation files.
Key changes:
- Updated documentation dependencies to latest versions (mkdocs 1.6.1, mkdocs-material 9.7.0)
- Replaced custom macro/jupyter plugins with mkdocs-multirepo-plugin and mkdocstrings for API documentation
- Standardized markdown formatting by breaking long lines into multiple lines
Reviewed changes
Copilot reviewed 203 out of 208 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| requirements-docs.txt | Updated documentation dependencies to latest versions |
| mkdocs.yml | Replaced custom plugins with mkdocstrings, added multirepo support, enabled dark mode theme |
| docs/user_guides/**/*.md | Broke long sentences into multiple lines for better readability |
| docs/js/dropdown.js | Removed custom dropdown JavaScript (no longer needed) |
Comments suppressed due to low confidence (1)
mkdocs.yml:1
- The cross-reference links contain incorrect step numbers. Step 4 links to
#step-6-optional-enable-kserveand Step 5 links to#step-7-optional-other-advanced-options, but they should link to#step-4-optional-enable-kserveand#step-5-optional-other-advanced-optionsrespectively.
site_name: "Hopsworks Documentation"
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
See logicalclocks/hopsworks-api#738 for the related PR. |
1 participant
No description provided.