-
Notifications
You must be signed in to change notification settings - Fork 21
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Switch to documenteer guide doc build #1089
base: main
Are you sure you want to change the base?
Conversation
cda48e2
to
49a4566
Compare
@jonathansick as discussed in #1081 I had a go at switching to the new documenteer guide. It sort of works but the bibtex stuff fails:
(although the build reports success) and no citations render. The menu also looks bad across the top of the page rather than being on the side like it was before. Does guide support bibtex? |
Yes, the new theme has a three-level navigational hierarchy. You'll need to rearrange the One thing I need to still mention in that guide is you can rename a "part" along the top bar to a shorter name than the natural page name by giving it a short name in the toctree. For example: .. toctree::
:hidden:
Guide <user-guide/index>
Releases <changelog>
This is happening because Markdown files are now eligible as content. You can exclude that content using [sphinx.exclude] in documenteer.toml: [sphinx]
exclude = [
"_templates/README.md"
]
Not out of the box. I added some review comments with the rest of the configuration. |
@jonathansick thanks for the fixes. However many toctrees I have it doesn't change the top bar. I don't really want a top bar at all -- the navigation on the left of all the sections was fine before. The documentation you linked to implied that if I group my pages with separate toctree lines then it would change the top bar but I must be doing something wrong because it has no effect and just adds a heading to the index page. |
e9fd176
to
a4ea315
Compare
Co-authored-by: Jonathan Sick <[email protected]>
a4ea315
to
93b379a
Compare
@jonathansick I've had another go but even if I manage to get smaller titles for the top of the top page, each lower page still gets the longer titles. The main document title also runs over the top menu bar. |
I'll make a PR based on this PR with the organization I have in mind. That'll be easier than trying to describe it. |
No description provided.