Refactor doc to restructure and improve #1943 - #2257
Merged
TG1999 merged 8 commits intoMay 4, 2026
Merged
Conversation
Copy link
Copy Markdown
Member
Sorry, something went wrong.
TG1999
reviewed
Apr 30, 2026
Comment thread
docs/source/index.rst
Outdated
Copy link
Copy Markdown
Contributor
|
@DennisClark we have some errors while building docs, we need a toctree. Also there are few files where we need to add a title. Thanks! |
Sorry, something went wrong.
Copy link
Copy Markdown
Contributor
|
@DennisClark you can add a toctree like this .. toctree:: :maxdepth: 2 :caption: Getting Started introduction installation user-interface api api-admin api_v3_usage .. toctree:: :maxdepth: 2 :caption: Tutorials tutorial_add_importer_pipeline tutorial_add_improver_pipeline .. toctree:: :maxdepth: 2 :caption: Reference reference_importer_overview reference_improver_overview reference_framework_overview reference_model_overview command-line-interface importers_link PIPELINES-AVID SOURCES .. toctree:: :maxdepth: 1 :caption: Misc faq misc soc_gsoc21 And add title in file which are missing title like this PIPELINES AVID ============== Also verify errors with make doc command. Let me know if you want to me take a look on any particular thing. Thanks! |
Sorry, something went wrong.
Copy link
Copy Markdown
Member
Author
|
@TG1999 looks like you've got the solution all figured out! Please go ahead with the change if you have time, thanks. |
Sorry, something went wrong.
Signed-off-by: Tushar Goel <tushar.goel.dav@gmail.com>
Signed-off-by: Tushar Goel <tushar.goel.dav@gmail.com>
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
Reviewers
Assignees
2 participants
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.
This PR is for:
@TG1999 and @keshav-space I have done the basic restructuring to format the rtd index to be consistent with
https://github.com/aboutcode-org/scancode.io/blob/main/docs/index.rst
Can you please check it over for syntax, etc.
The revised index.rst also points to these files, which I copied to docs/source (but have not removed them from the main level yet):
PIPELINES-AVID.rst
SOURCES.rst
api_v3_usage.rst
We'll probably want to add some explanatory text for the first two to give them some context; this is still a work-in-progress.