-
On pages with example options, or docstrings (e.g. [docstring examples](https://machow.github.io/quartodoc/get-started/docstring-examples.html)), showing rendered output would let users **see** what d…
-
## Description & Reasoning
In a few commands like `hacktoberissues`, we've hardcoded `.` as the prefix which won't make sense if a user is using a different prefix for the bot.
## Expected Beh…
-
Currently, if someone adds an image, a list structure or an equation to their Python code documentation using reStructuredText, or if someone browses the documentation of existing libraries that emplo…
-
**Thanks for your work and the awesome tool** ❤️
### Problem
Some docstring formats support raise blocks for describing potential exceptions a function may throw. However, neither LSP (pyright…
-
What I'm imagining is using `ast` to find and modify nodes, and when ready to emit (unparse) align with the FST so that only what the AST has changed will be modified.
Some caveats:
- Cannot delet…
-
Most classes, methods, functions do not have any docstrings for documentation.
[PEP 0257](https://www.python.org/dev/peps/pep-0257/) describes the standard format
Single line
``` python
def kos_root…
-
@rocky @mmatera and I have been discussing the possibility of using RsT for inline documentation instead of DocBook for a while. There are a couple of advantages with this.
First of all, RsT is be…
-
In IPython, the _Returns_ and _Raises_ sections of our docstrings are often a single block of text, not a definition list. In particular, where functions return a single value, it seems awkward to giv…
-
## Introduction
I am using `scalafmt` to enforce a very specific code style for university. Sadly, it is currently not possible to format docstrings as prescribed.
## Configuration
```HOCON
v…
xieve updated
3 weeks ago
-
This is a pain in the neck but I think migrating to `mkdocs` would pay off in the long run:
1. The build process is so much smoother and faster than Sphinx + RTD (live preview!)
2. Much more modern …