read-the-docs

I am very new to read the docs. I have a documentation folder docs in my github repo created using sphinx in my local machine. I tried to link the docs to readthedocs. From settings of the repo I added the read the docs service. From read the docs website I imported the project. But, the documentation in read the docs only shows the front page of index.html file. When I click any links all are empty. However, in my local machine all the links are text in it. My github repo is this: github repo My readthedocs link is : readthedocs docs File Structure docs html rst ** conf.py source Makefile src

Is it possible to hide the sidebar when using Sphinx with the ReadTheDocs theme? Extending the question a bit more, can I have it include the sidebar when issuing a command: $ make html and not include it issuing a command: $ make htmlhelp without altering code? Maybe add something in the layout.html. First of all, it is poor form to ask two questions in one post. Next time, create a separate question. For your first question, I am not sure what the option collapse_navigation actually does, but its name implies that it does what you seek. The default value is False , so toggle it to True and

I'm using sphinx and RST to generate some tech documentation as HTML and having issues getting a local PDF reference to work as a hyperlink. I've seen people use :download: to link to local PDFs, but I'm embedding the PDFs inside a /docs directory for reference. I don't like :download: because it doesn't display the PDF inline in the browser which requires an extra step on the users' behalf for consumption. sphinx-build -b html does not copy any files unless they are specified in config.py hook html_static_path or html_extra_path - and even then they are dropped to the root directory or

I want to publish the documentation of my project https://bitbucket.org/oaltun/opn in readthedocs.org. The build fails. There are different errors shown in the log https://readthedocs.org/builds/opn/2247789/ , but the first is "no module named sip". sip is needed by pyqt, which is needed by the project. Normally in this kind of situation, as far as I understand, you would add missing package to your setup.py, and check the readthedocs.org option to create a virtualenv. I do check the box to create a virtualenv. But I can not add sip or pyqt to setup.py. The problem is pyqt & sip does not use

How do I override the default Search html that comes with the Sphinx RTD theme. I am on Sphinx 1.5 and the theme is always imported and not static. See Templating in the Sphinx documentation. To customize the output of your documentation you can override all the templates (both the layout templates and the child templates) by adding files with the same name as the original filename into the template directory of the structure the Sphinx quickstart generated for you. Sphinx will look for templates in the folders of templates_path first, and if it can’t find the template it’s looking for there,

I want to extend the theme used by Sphinx and ReadTheDocs with my own custom styles. What is the best way I can do this so that my changes will stick? Assumptions Your RTD doc set has something like the following structure: (root path) (some other stuff not germane to this discussion) _static/ _templates/ conf.py You're also building locally using sphinx-build or sphinx-autobuild using the default theme, but your deployed server might use the sphinx-rtd-theme instead. Use Case: Hatnotes For this illustration, I'm going to show how to create custom styling for "hatnotes", a concept which is