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-документации. Всё это — на реальных задачах. Я постаралась собрать побольше примеров из личного опыта. Надеюсь, не слишком много.
https://habr.com/ru/articles/896998/
#ai #искусственный_интеллект #sphinx #документация #автоматизация #технический_писатель #рабочие_процессы #restructuredtext #chatgpt #sphinx_docs
Returning to writing documentation with #reStructuredText and #sphinx after many years of using only #markdown -- what a way to spend a beautiful spring day 😵
When writing plain-text files with collaborators, such as…
- #LaTeX, for instance on #Overleaf
- #reStructuredText, for instance for use with Sphinx/for @readthedocs
- #Markdown for many purposes.
…a practice I find very helpful is to:
1. Start every sentence on a new line, and
2. Not hard-wrap within sentences.
This makes it MUCH easier to read ordinary diffs and interpret the addition/removal/reordering of sentences, words, paragraphs, etc.
Why? What does #Shanthy has which for example #reStructuredText or #AsciiDoc don’t (not mentioning some dialect of #Markdown)?
RestructuredText is more powerful, and full featured than Markdown. Everyone should be using RestructuredText instead of Markdown for their documents and Static Site Generators.
🚀️ rst2gemtext v0.4.0 released!
rst2gemtext is a CLI tool and a #Python library to convert #reStructuredText to #Gemtext (the markup language used by #Gemini network).
➡️ https://github.com/flozz/rst2gemtext/releases/tag/v0.4.0
This release contains mostly fixes on lists of link and tables. Supported Python versions have also been updated. 😃️
ReText is a simple but powerful editor for markup languages. It is based on Markups module which supports Markdown, reStructuredText, Textile and AsciiDoc. One can also add support for custom markups using Python modules.
Github
https://github.com/retext-project/retext?via=tecmint
#reStructuredText ist als #Plaintext einfach so viel schöner und strukturierter als diese drölf Millionen #Markdown Dialekte 😍
🆕 #pandoc 3.6 has been released:
• Support for #mdoc as input format
• Improved parsing of #reStructuredText
• #Typst 0.12 support
• Safe handling of `--embed-resources` when combined with `--sandbox`
The default templates for LaTeX, ConTeXt, and Typst have been updated.
Thinking about transitioning my #blogging from #nikola to #mkdocs
Nikola is great but I've always felt like writing in Markdown is an also ran use case, as its native lingua franca is my long time nemesis #restructuredtext (Hate hate HATE! :) ).
mkdocs is built from the ground up to be super simple. Give it a pile of Markdown and it'll generate a site. There's a nice plugin for generating a blog:
https://github.com/squidfunk/mkdocs-material/blob/master/docs/setup/setting-up-a-blog.md
Sphinx 8.1.0 has just been released 🎉
Sphinx makes it easy to create intelligent and beautiful documentation. ✨
See here the changelog 👇
https://www.sphinx-doc.org/en/master/changes/index.html#release-8-1-0-released-oct-10-2024
#Python #Sphinx #Documentation #Generator #reStructuredText #MyST #Markdown
I like #reStructuredText, so this is the best one for me (but it can do #Markdown these days as well).
Novedades de @pandoc .
Pandoc es una utilidad para la conversión de formatos de archivo, en esencia, de texto plano, que utiliza una estructura de representación intermedia para poder "compilar" a otros formatos.
Ejemplo, puedes convertir de #ReStructuredText a #MarkDown o #LaTeX.
En su novedad, está el cambio de la dependencia para generar PDF por Weasyprint.
#pandoc
🚀🖊️ Just released: Sphinx Lint 1.0.0
You can add it to your pre-commit to help find nits in your reStructuredText docs.
https://pypi.org/project/sphinx-lint/
https://github.com/sphinx-contrib/sphinx-lint/releases/tag/v1.0.0
#Python #docs #SphinxLint #Sphinx #lint #reStructuredText #reST #rst #precommit
@pdcawley #Markdown acknowledges its #Textile, #Setext, #reStructuredText, et al influences but prioritizes human readability more: https://daringfireball.net/projects/markdown/syntax#philosophy
An episode from the series Why I Love #Emacs.
All of a sudden 👾 I had to start working with the #reStructuredText format.
Well, I just opened the `.rst` file, and _voilà!_ a proper nice highlighting and number of additional tools were already in place.
@bbatsov Exactly, if you made research on #Python programmers, you would get quite different results (we all use #reStructuredText ).
Actually, this really looks well! I have never been able to manage to write #groff documents, but this looks really well with plain #reStructuredText (or #rst) documents.
