Menu
I'm having a python-3 project that uses the plot-directive, but this currently not supported by ReadTheDocs. Therefore i want to generate and upload the documents as i would normally do with the PyPi repository, but use the -r option to specify a different url.
I've tried the following, but it fails:
$ python3 setup.py build_sphinx register upload_docs -r https://readthedocs.org/pypi
running upload_docs
Using PyPI login from /home/user/.pypirc
Using upload directory /home/user/work/wltp.git/docs/_build/html
Submitting documentation to https://readthedocs.org/wltp/pypi
Upload failed (404): OK
I've also tried the following urls, but nothing worked:
Is what i'm trying to achieve (in principle) possible?
494
Importing into ReadTheDocs Assuming your project is hosted on GitHub, you can proceed by linking your GitHub account to your ReadTheDocs account. By doing so, you can import your project by going on your ReadTheDocs dashboard and clicking the Import a project button.
Sphinx is what is called a documentation generator. This means that it takes a bunch of source files in plain text, and generates a bunch of other awesome things, mainly HTML. For our use case you can think of it as a program that takes in plain text files in reStructuredText format, and outputs HTML.
Sphinx is a powerful documentation generator that has many great features for writing technical documentation including: Generate web pages, printable PDFs, documents for e-readers (ePub), and more all from the same sources. You can use reStructuredText or Markdown to write documentation.
Open this file in your web browser to see your docs. Your Sphinx project is built. Edit your files and rebuild until you like what you see, then commit your changes and push to your public repository. Once you have Sphinx documentation in a public repository, you can start using Read the Docs by importing your docs.
Adding additional CSS or JavaScript files to your Sphinx documentation can let you customize the look and feel of your docs or add additional functionality. For example, with a small snippet of CSS, your documentation could use a custom font or have a different background color.
Ensure API doc lives in docs/source/ to avoid ReadTheDocs’ Sphinx builder not generating (missing) py-modindex Set html_theme to default in conf.py for “standard” ReadTheDocs theme Uncomment system path line in conf.py (may also need to add ../) to avoid Sphinx not finding your package and throwing import errors instead
Make autodoc actually work. sphinx-apidoc merely generates “stubs” for each of your modules. The stubs contain automodule directives which in turn inform sphinx-build to invoke autodoc to do the heavy lifting of actually generating the API documentation from the docstrings of a particular module.
Issue should now be fixed according to this issue.
106
answered Oct 13 '22 02:10
If you love us? You can donate to us via Paypal or buy me a coffee so we can maintain and grow! Thank you!
Donate Us With
