I have been using my own documentation system for years and am writing a program to convert sphinx so that it is easier for others to edit my documentation, and so that I no longer have to maintain it (It was written years ago in C). In this system one has a title and an abbreviated title for each section (web page) and the abbreviated titles are used for navigation.
Here is an example use of my documentation system: https://bradbell.github.io/dismod_at/doc/data_table.py.htm I am asking how to best reproduce this navigation functionality in sphinx ? On Wednesday, July 8, 2020 at 12:04:58 AM UTC-7 Matt from Documatt wrote: > Hi Bradley! > Question #1 - You can't use filename as document title. First section > found in document will become a document title. > > Baz will be document title: > > foo > > bar > > baz > === > > but document title is usually at the very top of the file: > > baz > === > > foo > > bar > > Question 2 - you speak about breadcrumb navigation. If you have correctly > described relations among documents using toctree directive, many themes > use breadcrumb > like > you > mention. Important here is to emphasize that > structure of book is described with toctree directive, not with on-disk > representation of document files. > > Matt > blog.documatt.com > > On Tue, Jul 7, 2020 at 8:47 PM Bradley Bell <bradley...@gmail.com> wrote: > >> I only use one heading at the top level for each file. >> The file name (without the .rst extansion) is a shorthand for the heading >> at the top of each file. >> >> I would like to use the file names, and only the file names in the >> navigation tree. >> The navigation for a section would show its children, and possible >> grandchilren, down to some configurable level. >> >> It would also be nice for the navigation to also show all the ancestors >> above the current section; i.e., >> the position of the current web page in the documentaion tree (using the >> file names). >> I currently do this with links at the top of each section; e.g., >> grand_parent > parent > current >> where grand_parent, parent, and current are the corresponding file names >> and grand_parent and parent are links. >> >> >> How do I do this using sphinx ? >> >> -- >> You received this message because you are subscribed to the Google Groups >> "sphinx-users" group. >> To unsubscribe from this group and stop receiving emails from it, send an >> email to sphinx-users...@googlegroups.com. >> To view this discussion on the web visit >> https://groups.google.com/d/msgid/sphinx-users/284685c5-9204-4ebf-bbe5-f505b01475bfo%40googlegroups.com >> >> <https://groups.google.com/d/msgid/sphinx-users/284685c5-9204-4ebf-bbe5-f505b01475bfo%40googlegroups.com?utm_medium=email&utm_source=footer> >> . >> > -- You received this message because you are subscribed to the Google Groups "sphinx-users" group. To unsubscribe from this group and stop receiving emails from it, send an email to sphinx-users+unsubscr...@googlegroups.com. To view this discussion on the web visit https://groups.google.com/d/msgid/sphinx-users/a2d4e685-1353-4d51-809f-df42398c353bn%40googlegroups.com.
