TriBITS icon indicating copy to clipboard operation
TriBITS copied to clipboard

Take full advantage of Sphinx in TriBITS documentation

Open bartlettroscoe opened this issue 4 years ago • 0 comments

Blocked by: #399

Description

With the completion of #399, the ReStructuredText-based documentation for TriBITS will be switched over to use Sphinx generation and with Read-the Docs theme and the simple DocUtils formatted output will be removed. With that, we can then take full advantage of the features of Sphinx to improve the TriBITS docuemntation. This issue will list the most critical actions to take to take advantage of Sphinx and make this work like people expect for such documentation.

Immediate changes

Break up each document into multiple HTML pages

Currently, each document is a single index.html page. This makes the search box worthless because it just returns the first "Introduction" section. Fixing this requires breaking up the document into multiple *.rst files and thing linking them together using a set of nested ..toctree:: directives. Then each of these *.rst documents will be a separate HTML page and the Sphinx-generates search feature will return hits to different HTML pages. This will take some time but we could likely do a pretty good job of this in a day or so.

Remove the in-text Table-of-Contents

With Sphinx managing the table-of-contents on the left margin, there is no need for it in the document itself. So remove the .. contents:: directive.

bartlettroscoe avatar Jul 27 '21 22:07 bartlettroscoe