Make various improvements to site/build_docs.py #589
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
added 6 commits
December 17, 2021 19:01
It seems that Hugo is perfectly capable of creating them by itself. A positive side effect of this change is that you can now run the script repeatedly (previously it would complain that the output directory already exists).
Also, use the actual repository root as the repository root, not the current directory. Change the variable names accordingly.
Currently, it overwrites files in the actual repo it is run from, which is inconvenient and dangerous (since any local changes are lost). Make it stage files in a temporary directory instead. This requires the `enableGitInfo` setting to be set to `false`, since we no longer run Hugo in a Git repository. This makes the "Last modified" information disappear from the generated pages. However, due to the way we currently generate documentation for old releases, that information is frequently incorrect anyway (for example: <https://openvinotoolkit.github.io/datumaro/v0.1.11/docs/contributing/>).
zhiltsov-max
approved these changes
Dec 21, 2021
zhiltsov-max
added a commit
to cvat-ai/cvat
that referenced
this pull request
Sep 15, 2022
- Added auth docs in API schema and SDK ApiClient/Config (fixes #1517) - Added SDK docs with API, SDK and CLI docs - Added `develop` branch in the docs - Allowed unauthorized access to `api/docs`, `api/swagger`, `api/schema` endpoints - Added `--insecure` env var to control host checks in CLI - Refactored `build_docs.py` (backported openvinotoolkit/datumaro#589) - Extracted requirements file for site
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
See the individual commits for details. The important commit (the one I started this whole thing for) is the last one; it's also the only commit that affects the output. The rest are just improvements I made along the way.
How to test
Run the script.
Checklist
developbranchLicense
Feel free to contact the maintainers if that's a concern.