-
Sphinxcontrib shoebot generates images but doesn't have the same issues (e.g it can place images in the build directory).
That directive extends SphinxDirective, not Directive which adds some conve…
-
I am migrating sphinx docs from .rst to .md.
Rst file:
```
.. php:method:: add($object, $region = 'Content')
Bla bla
:param $object: Xxx
```
Md/MyST file:
```
:::{php:method} …
-
All python code should be documented following Google Python Style for docstrings(http://sphinx-doc.org/latest/ext/example_google.html) and it should be possible to generate usable Sphinx documentatio…
-
It's not clear to me how a user would locate a proof pdf.
- Where should links to proofs appear? Sphinx / docs.rs / R docs?
- I would expect proofs to be findable with sphinx search, but https://doc…
-
Following Rick's [Sphinx instructions](https://github.com/CityofToronto/bdit_team_wiki/blob/master/sphinx/sphinx.md), and the [Sphinx-Gallery](https://sphinx-gallery.github.io/getting_started.html) an…
-
I think this might be the solution:
https://tech.michaelaltfield.net/2020/07/23/sphinx-rtd-github-pages-2/
https://stackoverflow.com/questions/49331914/enable-versions-in-sidebar-in-sphinx-read-th…
-
isue: the doc dir contains not only docs
solution: the doc dir should only contain the documentation. The generaion of reports is not documentation, but reports it must be moved in a different direct…
-
## Details
This is based on a comment from @humitos : https://github.com/readthedocs/readthedocs.org/issues/3885#issuecomment-1244001249
``build.commands`` does not allow to install extra packages…
-
In your example from https://raw.githubusercontent.com/miyakogi/m2r/master/docs/example.md:
```
Link to [document](example.md) in markdown.
```
links propertly to example.html (that is auto-ge…
-
## Details
* Read the Docs project URL: https://readthedocs.org/projects/pymc/
* Build URL (if applicable): https://readthedocs.org/projects/pymc/builds/24794393/
## Expected Result
Only one…