Tagged articles

reStructuredText

3 articles · Page 1 of 1

Apr 12, 2025 · Fundamentals

Markdown vs reStructuredText: Choosing the Right Markup Language for Your Documentation

This article compares Markdown and reStructuredText (RST), outlining their advantages, typical use‑cases, and a detailed syntax comparison, to help developers decide which markup language best fits simple notes or complex technical manuals.

MarkdownReadTheDocsSphinx

0 likes · 7 min read

Markdown vs reStructuredText: Choosing the Right Markup Language for Your Documentation

DevOps

Mar 17, 2016 · Operations

Using GitHub and ReadTheDocs for Collaborative Documentation: A Hands‑On Training Overview

This article describes how to create and maintain technical documentation collaboratively by writing source files in reStructuredText, hosting them on GitHub, and publishing them with ReadTheDocs, highlighting the workflow, benefits, and multi‑device accessibility demonstrated in a training session.

ReadTheDocsreStructuredText

0 likes · 5 min read

Using GitHub and ReadTheDocs for Collaborative Documentation: A Hands‑On Training Overview

MaGe Linux Operations

Dec 10, 2015 · Backend Development

Generate API HTML Docs with Sphinx: A Quick Step‑by‑Step Tutorial

This guide walks you through installing Sphinx, configuring the Read the Docs theme, generating reStructuredText from Python code, and building HTML documentation for your API, complete with project setup, conf.py tweaks, and custom module directives.

APIHTMLPython

0 likes · 4 min read

Generate API HTML Docs with Sphinx: A Quick Step‑by‑Step Tutorial