uwsgi-docs icon indicating copy to clipboard operation
uwsgi-docs copied to clipboard

Sidebar Nav in readthedocs grouping fails

Open avilaton opened this issue 8 years ago • 5 comments

I tried doing a bit of research to fix this and could not make much progress. Building docs directly after cloning works well, but switching to sphinx-rtd-theme destroys the sidebar and it is very hard to navigate the documentation. Any idea why this might be happening? Also I think docs could be placed in their own folders (i.e. changelog/) for easier contribution.

Thanks for any help in advance.

avilaton avatar May 24 '16 14:05 avilaton

If it's a sphinx-rtd-theme issue i don't how we can help unless you figure out if we can change something to make it work.

xrmx avatar May 24 '16 15:05 xrmx

But the project uses ReadTheDocs to host the documentation, why isn't it set as such in the conf.py file?

avilaton avatar May 24 '16 18:05 avilaton

@avilaton Sorry but i'm not understanding you. What I've understood is that you have changed conf.py to use a different theme and the rendered html broke somehow. If that's not the case please explain it again :) thanks

xrmx avatar May 25 '16 07:05 xrmx

I'm sorry I was not clear. Please visit https://uwsgi-docs.readthedocs.io/en/latest/ and look at the sidebar. You will see every single topic with no grouping. It sucks as a navigation. I cloned the repo and used make to build, but the conf.py is not set with the rtd theme. Any clearer now?

El mié., 25 may. 2016 4:57 a. m., Riccardo Magliocchetti < [email protected]> escribió:

@avilaton https://github.com/avilaton Sorry but i'm not understanding you. What I've understood is that you have changed conf.py to use a different theme and the rendered html broke somehow. If that's not the case please explain it again :) thanks

— You are receiving this because you were mentioned.

Reply to this email directly or view it on GitHub https://github.com/unbit/uwsgi-docs/issues/311#issuecomment-221500315

avilaton avatar May 25 '16 23:05 avilaton

Here is how the docs look directly built from the repo (see how nice the sidebar looks): screenshot from 2016-05-26 14-23-01 and here is how it looks in uwsgi read-the-docs: screenshot from 2016-05-26 14-15-58

avilaton avatar May 26 '16 17:05 avilaton