#sphinx

I generally like working with reStructuredText for technical documentation. I use it a lot both at work and on my own projects.

But the little detail that a single space off on the indentation turns something into a block quote, which happens *all the time* in lists with sub points, is rather annoying. They should have stuck with ">" for block quotes instead.

I see these accidental block quotes all the time in documentation.

#Programming #Dev #Documentation #RST #Sphinx

Earlier this year, I switched over to using the #denote #emacs package for managing the content on my #sphinx powered blog.

If you are interested in such things, I finally got around to writing up some notes on how I did this

https://www.alcarney.me/blog/2025/blogging-with-sphinx-and-denoteel/

Im Projekt #SPHINX haben das Fraunhofer ISE und Freesuns eine Pilotlinie für innovative PV-#Dachziegel mit Matrix-Schindeltechnologie aufgebaut.

Die Module sind effizient, ästhetisch und ideal für #Bestandsbauten und #Denkmalschutz. Durch versetzt angeordnete #Solarzellen erreichen sie höhere Leistung und bessere #Verschattungstoleranz.

Die EU-geförderte Entwicklung soll gebäudeintegrierte #Photovoltaik-Elemente schneller marktreif machen.

https://www.ise.fraunhofer.de/de/presse-und-medien/presseinformationen/2025/pilotlinie-fuer-pv-dachziegel-mit-matrix-schindeltechnologie-aufgebaut.html

#Solarenergie #Energiewende

#ShitIFind #Pokemon #Oedipus #Sphinx #Riddles

Hawkmoth v0.21.0 is out.

Hawkmoth is a Sphinx extension to incorporate formatted C and C++ source code comments written in
reStructuredText into Sphinx based documentation.

v0.21.0 has improved support for documenting function pointer typedefs, fixes issues in looking up parsed results, and enables REUSE compliance.

https://jnikula.github.io/hawkmoth/stable/

#sphinx #c #documentation #hawkmoth

Faz um tempo que quero colocar um blog no meu site acadêmico. Eu já uso #sphinx para gerar as páginas das disciplinas e queria algum outro gerador estático para a home page.

Depois da Live de Python especial de aniversário, onde o @dunossauro incentivou a galera a blogar fora das grandes plataformas, o desejo se intensificou, mas ficou naquela de "quando eu tiver algo a escrever eu vejo isso".

Passa umas semanas, e só hoje durante o banho tive meia dúzia de ideias do que escrever, a saber:

Now looking at sphinx documentation and startup for 20 minutes and I just don't get what the concept is. It seems to be more like a static web page thingy which happens to be able, if one digs a few hours more, to extract doc strings from python and do things. Hell, where is the command line like 'sphinx py/*.py -d htmlout' and be done? OK, I assume for now that this is not the intended use case. So off to the next one, pdoc (not pydoc).

#python #sphinx

https://www.youtube.com/watch?v=2cxSP90gj8c [Vappu is May Day]

Just released!

termcolor 3.1.0
Add true colour, cache system lookups
https://github.com/termcolor/termcolor/releases/tag/3.1.0

em-keyboard 5.1.0
Add Emoji 16.0: 🫩 🫆 🪾 🫜 🪉 🪏 🫟 🇨🇶
https://github.com/hugovk/em-keyboard/releases/tag/v5.1.0

Humanize 4.12.3
Fix regression in naturalsize, improve French translation
https://github.com/python-humanize/humanize/releases/tag/4.12.3

Python Docs Theme 2025.4.1
Fix copy button with multiple tracebacks
https://github.com/python/python-docs-theme/releases/tag/2025.4.1

#Python #release #termcolor #humanize #Sphinx #theme #EmKeyboard #PythonDocsTheme

Just released: Python Docs Theme 2025.4

Require Sphinx 7.3
Add support for Python 3.14
Drop support for Python 3.10-3.11
Copy button for code samples
PEP 639 licence metadata
and more!

https://github.com/python/python-docs-theme/releases

Thanks to Tomas Roun for the copy button! Demo:

https://docs.python.org/3.14/whatsnew/3.14.html#pep-758-allow-except-and-except-expressions-without-parentheses

#Python #Sphinx #release #docs

What do y’all use to render your API docs in Sphinx?

I’m nearly ready to just give up and use ReDoc/Swagger/etc, but I’d prefer something that integrates with the existing docs. But I just spent an hour poking at sphinxcontrib-openapi and its OpenAPI v3 support is just very patchy and sad …

#python #sphinx

Did you know that the famous Great #Sphinx of Giza didn't just lose her nose?

She also lost her #beard.

It was long & braided, like that of pharaohs.

The Sphinx was also originally multicoloured.

#history #ancientegypt

*𝘀𝗹𝗮𝗽𝘀 𝗿𝘂𝗺𝗽 𝗼𝗳 𝗯𝗲𝗮𝘀𝘁* this bad boy can fit so many fucking renders in it

#sphinx #demon #BlackButler #Kuroshitsuji #VaultFiles

AI в работе технического писателя

Всем привет! Меня зовут Севара Ахтямова и я работаю техническим писателем – аналитиком около 4 лет. В этой статье я расскажу, как AI помог мне справиться с рабочей рутиной — от генерации toctree до отладки сборки Sphinx-документации. Всё это — на реальных задачах. Я постаралась собрать побольше примеров из личного опыта. Надеюсь, не слишком много.

https://habr.com/ru/articles/896998/

#ai #искусственный_интеллект #sphinx #документация #автоматизация #технический_писатель #рабочие_процессы #restructuredtext #chatgpt #sphinx_docs

#SilentSunday #Egypt #pyramids #Giza #Sphinx

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.

https://github.com/swyddfa/esbonio.el