Stuck on an issue?
Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.
And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.
Document how to integrate with Sphinx
See original GitHub issueDescription of problem
Currently neither the GitHub README nor the official site (https://rst2pdf.org/) document how to integrate this package with Sphinx.
The best info I could find is: https://stackoverflow.com/a/47720278/1398841
But it seems like this should be documented in the package itself. For example, it’s not immediately clear what each of the items in the pdf_documents refer to.
Issue Analytics
- State:
- Created 4 years ago
- Reactions:2
- Comments:7 (5 by maintainers)
Top Results From Across the Web
Welcome — Sphinx documentation
Sphinx makes it easy to create intelligent and beautiful documentation. Here are some of Sphinx's major features: Output formats: HTML (including Windows ...
Read more >Getting Started with Sphinx - Read the Docs
Generate web pages, printable PDFs, documents for e-readers (ePub), and more all from the same sources · You can use reStructuredText or Markdown...
Read more >Documenting Your Project Using Sphinx - PythonHosted.org
To get started, cd into the documentation directory and type: $ sphinx-quickstart Please enter values for the following settings (just press Enter to...
Read more >Write Beautiful Python Documentation with Sphinx
Sphinx is an amazing tool for writing beautiful documentation. Originally created for the documentation of the Python programming language, ...
Read more >27. How to document your code with Sphinx
Our sphinx setup is rather simple: First it will include the framework ... how to automatically add python documentation to the sphinx document...
Read more >
Top Related Medium Post
No results found
Top Related StackOverflow Question
No results found
Troubleshoot Live Code
Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free
Top Related Reddit Thread
No results found
Top Related Hackernoon Post
No results found
Top Related Tweet
No results found
Top Related Dev.to Post
No results found
Top Related Hashnode Post
No results found
Also, it’s not clear (at least to me) how to control the
versionthat is put on the cover page?I didn’t point it out earlier, but the manual does have some words on Sphinx integration here https://rst2pdf.org/static/manual.html#sphinx. Clearly we’re not surfacing this well though and it is very minimal.