Tagged articles
Sphinx
11 articles · Page 1 of 1
This guide explains why Sphinx and ReadTheDocs are a powerful combination for generating and hosting documentation, and provides step‑by‑step instructions—including installing dependencies, initializing the project, configuring conf.py, adding a .readthedocs.yml file, and linking the repository—so that documentation is built automatically on each commit.
DevOpsPythonReadTheDocs
0 likes · 6 min read

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

This article explains how to use Setuptools to manage dependencies, package source code, and provide command-line tools, and demonstrates a step‑by‑step example of integrating Sphinx to automatically generate documentation and include it in a Python package build.
PythonSphinxbuild
0 likes · 4 min read

This article explains why MySQL LIKE queries struggle with large datasets, introduces Elasticsearch and Sphinx as powerful PHP search engine alternatives, and provides step‑by‑step PHP code examples for setting up indices, adding documents, and performing full‑text searches.
BackendElasticsearchPHP
0 likes · 5 min read


DevOpsSep 6, 2023 · Fundamentals
The article explains why technical documentation is often neglected, introduces a document‑quadrant framework to organize content, compares structured and graph‑based approaches, and evaluates tools like Sphinx, Docusaurus, Google Docs, Confluence, and Logseq for creating maintainable, high‑quality documentation.
DevOpsSphinxdocumentation tools
0 likes · 8 min read

This guide explains how Citus shards data across machines to horizontally scale SQL queries for workloads over 100 GB, then walks through cloning the Citus 11 docs repository, setting up a pyenv‑based Python environment, installing Sphinx requirements, and launching the documentation in watch mode for local browsing.
CitusDistributed DatabasePostgreSQL
0 likes · 3 min read

This article explains why and when to scan product code for vulnerabilities, describes static source‑code and binary scanning methods, introduces deep code‑search techniques and a real‑time Sphinx‑based indexing architecture, and shows how these practices can significantly raise overall product quality.
IndexingProduct QualitySphinx
0 likes · 13 min read

The article explains how static source‑code scanning, binary analysis, and advanced code‑search technologies—including incremental indexing, deduplication, real‑time Sphinx indexing, and BM25 ranking—can be combined to detect and remediate product‑level vulnerabilities early, thereby significantly raising software quality and reducing risk.
BM25Sphinxcode search
0 likes · 13 min read

The article explains why and when to scan product code for vulnerabilities, describes static source‑code and binary scanning methods, introduces deep code‑search techniques, outlines the system architecture and incremental indexing pipeline, and shows how these practices can substantially raise overall product quality.
Code ScanningProduct QualitySphinx
0 likes · 13 min read


DevOpsJan 8, 2017 · Operations
This article describes how to build an automated documentation publishing pipeline using VSTS CI, Azure FTP deployment, Sphinx conversion, Docker containers, and GitHub synchronization, enabling one‑click HTML generation and backup for Markdown/reStructuredText sources.
AzureCI/CDDevOps
0 likes · 5 min read

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
