Echoes of Language
"The Sphinx"
https://art.blackcatwhitehatsecurity.com/imageViewer.cfm?id=72
#Sphinx #ArtificialIntelligence
Echoes of Language
"The Sphinx"
https://art.blackcatwhitehatsecurity.com/imageViewer.cfm?id=72
#Sphinx #ArtificialIntelligence
Ok, I think this is strictly a numpydoc feature that involves the use of their built in xref's which sphinx.ext.napoleon does not have access to.
Looking at the docstrings for numpy, they appear to use the same style of annotations:
```
range : (float, float)
The lower and upper range of the bins.
```
Suppose I should take a closer look at their conf.py and see if there is magic there…
#sphinx #numpydoc folks, I have a question.
When specifying a parameter
```
"""
...
levels : (float, float)
description.
...
“””
```
sphinx is givingm e warnings:
WARNING: py:class reference target not found (float [ref.class]
WARNING: py:class reference target not found float) [ref.class]
I know I can get around this by specifying the type as
leves : tuple(float, float)
But not having to specify tuple makes it much nicer looking (and the parenthesis imply it).
suggestions on how to work around this?
Hawkmoth v0.20 is out!
Hawkmoth is a Sphinx extension to import C and C++ documentation comments into Sphinx based documentation.
The main new feature in this release is automatic configuration of the system header search paths. Unfortunately, libclang does not get them right out of the box on most distros, so we have to help it a little.
AI в работе технического писателя
Всем привет! Меня зовут Севара Ахтямова и я работаю техническим писателем – аналитиком около 4 лет. В этой статье я расскажу, как AI помог мне справиться с рабочей рутиной — от генерации toctree до отладки сборки Sphinx-документации. Всё это — на реальных задачах. Я постаралась собрать побольше примеров из личного опыта. Надеюсь, не слишком много.
A commission for Pale Peryton, who found the idea of two creatures, neither of whom possess thumbs!
Someone get these two their medallions!!!
I sketched something silly one morning and he paid me to finish it.
whooo prime space on the latest planet #dyne: https://news.dyne.org/planet-dyne-s2025-e03/ sphinx promoted and they run their own #sphinx server! wooo
I have a whole litter of adoptable kitties that need to find new homes at #MidwestGamingClassic. Do you see someone who looks like your fuzzy buddy?
Returning to writing documentation with #reStructuredText and #sphinx after many years of using only #markdown -- what a way to spend a beautiful spring day
“Every child is a Sphinx; none knoweth its secret but itself; presumeth Ignorance to initiate Isis? Let the Sphinx brood on its secret, until its hour; one can assist only by leaving it to contemplate existence. Let it behold all things in Earth and Heaven.”
After using #emacs on and off for years, I've finally learnt enough elisp to try writing a package!
esbonio.el provides the necessary glue code to use the esbonio language server with either eglot or lsp-mode, so if you write your #sphinx docs in Emacs you might find this useful. However, it is currently only available via `package-vc-install` or similar.
\o/ @dyne now hosts the first public sphinx server not under my control at sphinx.dyne.org:443
their ltsigkey is
`TnQHEiiJtFXqhUskqAxtIhG/xlk9t79BXyLcofai32g=`
i'm gonna move the current public v1 sphinx server on pwd.ctrlc.hu from port 443 to 2443, and a new v2 server will be set up on port 443 very very soon.