#restructuredtext — Public Fediverse posts

#Papirus 's icon for #ReText is annoying me right now. I'll just do something about that.

By the way, is there an accepted logo for #reStructuredText anywhere, other than the LaTeX-like wordmark on Wikipedia?

#Python #YearOfTheLinuxDesktop

In the age of AI generated #markdown humans should start using #reStructuredText documents 🤔

I just published a Sphinx extension to add colspan and rowspan to .rst tables: https://pypi.org/project/rst-table-span/

#python #docutils #sphinx #rst #reStructuredText

I just published a Sphinx extension to add colspan and rowspan to .rst tables: https://pypi.org/project/rst-table-span/

#python #docutils #sphinx #rst #reStructuredText

I just published a Sphinx extension to add colspan and rowspan to .rst tables: https://pypi.org/project/rst-table-span/

#python #docutils #sphinx #rst #reStructuredText

I just published a Sphinx extension to add colspan and rowspan to .rst tables: https://pypi.org/project/rst-table-span/

#python #docutils #sphinx #rst #reStructuredText

I just published a Sphinx extension to add colspan and rowspan to .rst tables: https://pypi.org/project/rst-table-span/

#python #docutils #sphinx #rst #reStructuredText

@bithive @timpritlove Me too, because it has a specification from the beginning and not a post specification effort as common mark.

However, Markdown is easy to learn and suits use cases that are enough for many users.

#markdown #restructuredtext

#Markdown Is a Disaster: Why and What to Do Instead
https://karl-voit.at/2025/08/17/Markdown-disaster/

Here's my article where I summarize the subtle and no so subtle downsides when you choose Markdown for your information instead of a different markup syntax that doesn't come with all the downsides of #MD.

#publicvoit #orgdown #orgmode #LML #pandoc #rst #restructuredtext #asciidoc #Wikitext #BBCode #Creole #Crossmark #Djot #CommonMark #lockin

#Markdown Is a Disaster: Why and What to Do Instead
https://karl-voit.at/2025/08/17/Markdown-disaster/

Here's my article where I summarize the subtle and no so subtle downsides when you choose Markdown for your information instead of a different markup syntax that doesn't come with all the downsides of #MD.

#publicvoit #orgdown #orgmode #LML #pandoc #rst #restructuredtext #asciidoc #Wikitext #BBCode #Creole #Crossmark #Djot #CommonMark #lockin

#Markdown Is a Disaster: Why and What to Do Instead
https://karl-voit.at/2025/08/17/Markdown-disaster/

Here's my article where I summarize the subtle and no so subtle downsides when you choose Markdown for your information instead of a different markup syntax that doesn't come with all the downsides of #MD.

#publicvoit #orgdown #orgmode #LML #pandoc #rst #restructuredtext #asciidoc #Wikitext #BBCode #Creole #Crossmark #Djot #CommonMark #lockin

#Markdown Is a Disaster: Why and What to Do Instead
https://karl-voit.at/2025/08/17/Markdown-disaster/

Here's my article where I summarize the subtle and no so subtle downsides when you choose Markdown for your information instead of a different markup syntax that doesn't come with all the downsides of #MD.

#publicvoit #orgdown #orgmode #LML #pandoc #rst #restructuredtext #asciidoc #Wikitext #BBCode #Creole #Crossmark #Djot #CommonMark #lockin

#Markdown Is a Disaster: Why and What to Do Instead
https://karl-voit.at/2025/08/17/Markdown-disaster/

Here's my article where I summarize the subtle and no so subtle downsides when you choose Markdown for your information instead of a different markup syntax that doesn't come with all the downsides of #MD.

#publicvoit #orgdown #orgmode #LML #pandoc #rst #restructuredtext #asciidoc #Wikitext #BBCode #Creole #Crossmark #Djot #CommonMark #lockin

I'm trying to add a vertical timeline to my sphinx project. There is an extension that does this? The `sphinx-timeline` is only horizontal.

Ideally I could add internal links in the description or bubble too.

#sphinx #restructuredtext #help

🚀️ rst2gemtext v0.5.0 released!

I just released a new version of my lib to convert reStructuredText to Gemtext (the Gemini markup language).

➡️ https://github.com/flozz/rst2gemtext/releases/tag/v0.5.0

This version fixes an ImportError with newer versions of docutils and improved the outputed gemtext.

#python #reStructuredText #gemini #OpenSource

#reStructuredText, which pre-dates #Markdown, has always been superior for my purposes @danielittlewood.

https://www.docutils.org/rst.html

Twisted's coding standard for our #ReStructuredText files is to use what we have termed "semantic newlines". That is to say: every sentence is on its own line. In principle, I like this. It means smaller, more readable diffs, and less pointless churn. In practice, with my #Emacs fill-paragraph muscle memory, it is a *constant* frustrating exercise where I'm tripping over myself and either constantly re-wrapping and then manually un-wrapping, or forgetting to wrap at all.

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.

#Sphinx #Hawkmoth #Documentation #reStructuredText #C

https://github.com/jnikula/hawkmoth

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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.

RestructuredText is more powerful, and full featured than Markdown. Everyone should be using RestructuredText instead of Markdown for their documents and Static Site Generators.

#RestructuredText #Markdown #SSG #WebDev #DevLife

🚀️ 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. 😃️

@ax6761 @perl I sympathize. Would that mean you would author #Perl POD but then convert to #reStructuredText for #Python? Because #Pandoc can already do that as of this week:

```
pandoc --from=pod --to=rst
```

🆕 #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.

https://github.com/jgm/pandoc/releases/tag/3.6

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

@kurau

https://getpelican.com/

I like #reStructuredText, so this is the best one for me (but it can do #Markdown these days as well).

#OpenWeb #Blog #SmallWeb

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

@paulox https://fosstodon.org/@paulox/113140526345298176

🚀🖊️ 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.

#whyILoveEmacs

@bbatsov Exactly, if you made research on #Python programmers, you would get quite different results (we all use #reStructuredText ).

@pandoc

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.

Years in the execution, the #Biopython Tutorial has just switched from #LaTeX with HTML output via hevea http://biopython.org/DIST/docs/tutorial/Tutorial-1.82.html to #reStructuredText #RST output with #Sphinx https://biopython.org/docs/dev/Tutorial/index.html

@plantarum @b0rk @pluralistic I edited some Emacs #texinfo files a couple of times and found it always a bit verbose and quirky, but not really worse than the newer #restructuredText or #asciidoc.

@mirabilos @joel @tilvids @sotolf @benjaminhollon @thelinuxcast

I actually really like #markdown, mostly because it's little more than a distillation/refinement of some wiki formats I've used in the past, like #WikkaWiki and older versions of @TiddlyWiki (which I really loved).

But no, TeX, it ain't. It's not even trying to be @mediawiki.

There are definitely better formats if precision is a goal. Maybe #ReStructuredText? (I really don't know anything about it).

ReText: Ein einfacher Markup-Editor

ReText ist ein leichtgewichtiger Editor. Er erleichtert das Arbeiten mit Markdown und reStructuredText.

#markdown #reStructuredText #ReText #Editor #Schreiben #Linux

https://gnulinux.ch/retext

Crear una libreta artesanal A7 para capturar ideas en papel

#A7 #Artesanal #Blog #hispterPDA #Libreta #Moleskine #papel #Pocketmod #reStructuredText

https://osiux.com/capturar-ideas-en-papel-de-moleskine-hispterpda-pocketmod-y-libreta-artesanal.html

Crear una libreta artesanal A7 para capturar ideas en papel

#A7 #Artesanal #Blog #hispterPDA #Libreta #Moleskine #papel #Pocketmod #reStructuredText

https://osiux.com/capturar-ideas-en-papel-de-moleskine-hispterpda-pocketmod-y-libreta-artesanal.html

Crear una libreta artesanal A7 para capturar ideas en papel

#A7 #Artesanal #Blog #hispterPDA #Libreta #Moleskine #papel #Pocketmod #reStructuredText

https://osiux.com/capturar-ideas-en-papel-de-moleskine-hispterpda-pocketmod-y-libreta-artesanal.html

Crear una libreta artesanal A7 para capturar ideas en papel

#A7 #Artesanal #Blog #hispterPDA #Libreta #Moleskine #papel #Pocketmod #reStructuredText

https://osiux.com/capturar-ideas-en-papel-de-moleskine-hispterpda-pocketmod-y-libreta-artesanal.html

Crear una libreta artesanal A7 para capturar ideas en papel

#A7 #Artesanal #Blog #hispterPDA #Libreta #Moleskine #papel #Pocketmod #reStructuredText

https://osiux.com/capturar-ideas-en-papel-de-moleskine-hispterpda-pocketmod-y-libreta-artesanal.html

@colepeters @remotesynth

There are parallels here for tech writers too, with #FrameMaker, #DocBook, #AsciiDoc, #ReStructuredText or #DITA.

Each tool we learn teaches us something about the others.

Alabaster is now officially part of the sphinx-doc Github org! 🎉 https://github.com/sphinx-doc/alabaster

I'll still keep my fingertips in, but hopefully this removes me as a _bottleneck_ for development.

Big thanks to Adam Turner (AA-Turner on GH) for shepherding the process ❤️

#Python #Sphinx #documentation #Alabaster #ReStructuredText

#reStructuredText follows the logic that underlined text means that it's a link, so it doesn't have dedicated syntax for (non-link) underlined text either. Support can be added with this syntax

.. role:: underline
:class: underline

:underline:`this`

in combination with a short #LuaFilter

function Span(s)
return s.classes[1] == 'underline' and pandoc.Underline(s.content) or nil
end

#pandoc #rst #underline

#Orgdown (= #OrgMode Syntax) Is One of the Most Reasonable #Markup Languages to Use for Text https://karl-voit.at/2017/09/23/orgmode-as-markup-only/

#publicvoit #LML #markdown #AsciiDoc #Wikitext #reStructuredText #rst #pandoc

#rst2pdf is a #rST to #PDF converter.

rst2pdf compiles #reStructuredText into PDF files. rst2pdf supports all of the regular directives from rST, but adds syntax highlighting, counting index numbers, and a subset of LaTeX. rst2pdf's page formatting, quote characters, etc., are controlled using a configuration file and stylesheets. rst2pdf supports extensions.

Website 🔗️: https://rst2pdf.org/

apt 📦️: rst2pdf

#free #opensource #foss #fossmendation #programming