Repository navigation
[docs] Overhaul documentation for #589 - #594
Open
Breakthrough wants to merge 1 commit into
Open
Breakthrough wants to merge 1 commit into
Breakthrough wants to merge 1 commit into
Conversation
The documentation was in dire need of some improvements as the volume of features PySceneDetect supports has grown. This splits out the CLI and API docs as separate entities, while making it easier to switch between the two. It also improves the ability to find config file docs and sections.
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
Comment on lines
+819
to
+820
| ".. NOTE: This file is auto-generated by docs/generate_cli_docs.py and should not be" | ||
| " modified.\n\n", |
Comment on lines
+947
to
+948
| ".. NOTE: This file is auto-generated by docs/generate_cli_docs.py and should not be" | ||
| " modified.\n\n", |
This branch has not been deployed
This file contains hidden or 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
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.
The documentation was in dire need of some improvements as the volume of features PySceneDetect supports has grown. This splits out the CLI and API docs as separate entities, while making it easier to switch between the two. It also improves the ability to find config file docs and sections.
The docs generator now supports relations between similar items across each surface (API, CLI, and config file).