-
-
Notifications
You must be signed in to change notification settings - Fork 26
Allow sidebars on index.html #3
Comments
I'm not sure what you mean; you can manipulate the return value of We could certainly consider changing the default, though, if that makes sense. |
Just FYI: you guessed right, it's possible to change this locally by changing these lines on
(note: not sure about what the second one does exactly) to something like:
and then modifying this according to your needs (e.g. removing the |
Right, I know it can be modified locally, but I'm looking to minimize the amount of custom configuration needed for a simple package. Not everyone writing documentation is a sphinx expert (that includes me). At the minimum, this should be mentioned in the readme. |
I suppose it might be as simple as adding an optional argument to |
I'd rather swap the default and make Julia's docs be the special case rather than introduce a special-purpose configuration option if that makes the most sense, but I think I'd like to wait until after 0.2 to do that. |
Would it be possible to detect whether the docs are a single page, and in that case having |
Not sure; would need to review the Sphinxification process. Good idea, though. |
Bumping this now that 0.2 is out. |
Bump again. |
We're using JuliaDoc on RTD for JuMP's documentation (https://jump.readthedocs.org/en/latest/jump.html). RTD assumes that an index.html is present, otherwise many built-in links are broken; however, when we rename
jump.rst
toindex.rst
, the table of contents sidebar is no longer present.I'm guessing this is related to:
in
__init__.py
.I could probably hack this locally, but could we make this more customizable so that it's easier for julia packages to use?
The text was updated successfully, but these errors were encountered: