Dear Matthias,
thanks for your message.
Am 26.09.2018 18:19 schrieb Matthias Geier:
But I think it makes sense to manually select which modules you want
to be scanned for your documentation. You might have some internal
modules which you don't want to appear in the docs, for example.
You
Dear Matthias,
I fixed the module name and added a autodoc command to the rst file -
see in upstream.
The result is the same. The "module index" in the docs is empty.
--
You received this message because you are subscribed to the Google Groups
"sphinx-users" group.
To unsubscribe from this
Hello,
I wonder about if and how types of function/method parameters are
highlighted.
A good example about "highlighting" is the Pandas docu.
https://pandas.pydata.org/docs/reference/api/pandas.DataFrame.compare.html
Here you see the type and the default value behind the parameter name.
And
Hello Miguel
Am 09.03.2022 03:36 schrieb Miguel Villa Floran:
GitHub Pages. Has anyone implemented this approach before?
Not on GitHub but on Codeberg (based on Gitea).
Here is the landing page of my repo. On top of the README.md you can see
a link to the "page" directing to the "docs"
Am 02.03.2022 10:19 schrieb c.bu...@posteo.jp:
I was looking into the current/stable (?) official docu
https://www.sphinx-doc.org/en/1.5.1/tutorial.html
I have to correct myself. This is an outdated version. (See #10229 and
#10230) of the documentation.
The current stable docu does not say
I found a blog/tutorial from 2017.
https://eikonomega.medium.com/getting-started-with-sphinx-autodoc-part-1-2cebbbca5365
The sphinx-quickstart there asks an autodoc related question:
"autodoc: automatically insert docstrings from modules (y/n):"
Am I correct that this is gone in the
Am 02.03.2022 10:10 schrieb c.bu...@posteo.jp:
Am I correct that this is gone in the current stable release of
sphinx? And what is the design thinking behind it? What changed in the
years?
I was looking into the current/stable (?) official docu
https://www.sphinx-doc.org/en/1.5.1/tutorial.html
Hello,
just an elementary question about how Sphinx.
Does Sphinx parse the py-files as text files?
Or does Sphinx load and run the whole code and inspect its objects and
docstrings?
So when I would dynamically add extra code, attributes via setattr()
does Sphinx recognize that?
e.g. like
Hello,
I have a working Sphinx project at
https://github.com/bit-team/backintime/tree/dev/common/doc-dev
When I want to add a new rst file (representing a new py file) I also
have to add the name of that file (without the rst extension) to a
"toctree". If not I do get "WARNING: document
Hello,
in the past my python docstrings looked like this.
def foobar(val):
"""
Args:
val (str): A value.
"""
The resulting HTML output looked OK to me. The "str" type is shown in
the "Paramters::" list.
Today I tried type annotation and removed the "str" from the
10 matches
Mail list logo
