Add sphinx support for documentation #4949
Conversation
| :maxdepth: 1 | ||
| :caption: User Guide | ||
|
|
||
| user_guide/performance_tuning |
There was a problem hiding this comment.
Is this code generated? Or we need to add the pointer to newly added markdown file to properly render the table of content.
There was a problem hiding this comment.
It is not user generated. It is the templates that sphinx uses to render the left side nav bar. It is some sphinx magic that makes it work and is not intended to be read on GitHub. Note the {toctree} at the top of the section. This tells Sphinx to render a table of contents and it has it's own method to generate the correct links from this. See https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#directive-toctree for more info.
There was a problem hiding this comment.
I meant to ask that if we are adding new documentation page for new feature (say "protocol/extension_new_feature.md"), do we need to manually add the entry "protocol/extension_new_feature" in this file to make sure it is included in the rendered documentation.
I was hoping that this file is automatically generated by a script that scans the file directory for documentation
docs/customization_guide/build.md
Outdated
| @@ -274,11 +274,11 @@ issues since non-supported versions are not tested. | |||
| ## <a name="windows"></a>Building for Windows 10 | |||
There was a problem hiding this comment.
FYI that we can remove the a tag if we use title a ref link instead.
There was a problem hiding this comment.
Noted, I can do that.
|
Can we add the link to the hosted docs in the about section? |
There are a lot of new files here needed for Sphinx. For review, please look at changes made to .md files, or any new .md files. DM me for a link to the compiled documentation version to see what it will look like.