-
Notifications
You must be signed in to change notification settings - Fork 133
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
how to customize titles of the generated pages ? #427
Comments
Thanks for trying out an alpha build and providing your feedback! As for "pre" tags, I've always been on the fence about whether I like the look of the monospaced headings, both on the page and in the side bar. The links that it outputs aren't really useful and, as you say, it comes at the cost of not wrapping. So I'd be up for removing that too. |
So you are even suggesting to change the default template ? In the meantime could you advise on the process I should follow to update the templates ? My guess is that I should override these files: https://github.com/ansys/sphinx-autoapi/blob/feat/single-page-option/autoapi/templates/python/class.rst but I don't know where to store then in my build. Also I see the the title of the template is just a regular title with "====": https://github.com/ansys/sphinx-autoapi/blob/feat/single-page-option/autoapi/templates/python/method.rst so where is the "pre" tag coming from ? |
Documentation on editing the templates is here: https://sphinx-autoapi.readthedocs.io/en/latest/how_to.html#how-to-customise-layout-through-templates v3.1.0a3 isn't using that branch. It's using |
I'm using sphinx-autoapi to build my documentation and specifically the release 3.1.0a3 to build every method of my classes on a specific page: https://geetools.readthedocs.io/en/latest/autoapi/index.html
The problem is that now the titles are way too long to be displayed on a single line and "pre" tags in my html build don't wrap as normal text.
I would like to display them as pure h1 as in the pandas documentation to ensure they behave as normal text.
I assume I need to modify a template but I didn't understand which one and where to store it when reading your documentation
The text was updated successfully, but these errors were encountered: