Memo about Sphinx Part 1 (Creating a project)

Sphinx is a documentation tool written in Python. Unlike Word, you can write documents like a program. Sphinx Japan Users Association Page

Procedure memo of how to make a project and how to build.

environment

OS:Mac OS X 10.9.5 Python:Ver.2.7.7

How to make a project

$ sphinx-quickstart

・ ・ ・
#Project name and author name.
The project name will occur in several places in the built documentation.
> Project name: #Project title
> Author name(s): #Author name
・ ・ ・
#Project version
Sphinx has the notion of a "version" and a "release" for the
software. Each version can have multiple releases. For example, for
Python the version is something like 2.5 or 3.0, while the release is
something like 2.5.1 or 3.0a1.  If you don't need this dual structure,
just set both to the same value.
> Project version: 2014.09.27
> Project release [2010.09.27]:
・ ・ ・

How to build

Output in HTML

$ make html

HTML is generated in the _build / html folder. Open ** index.html ** and you have a document.

Output with epub

$ make epub

Generated in the _build / epub folder.

Output in Latex format

$ make latex

Generated in the _build / latex folder.

Recommended Posts

Memo about Sphinx Part 1 (Creating a project)
Is it okay with such a patch? (Memo about mock ~ Part 2 ~)
Commands for creating a new django project
Memo for creating a text formatting tool
Machine learning memo of a fledgling engineer Part 1
DJango Memo: From the beginning (creating a view)
A memo about writing merge sort in Python
A memo when creating a python environment with miniconda
Machine learning memo of a fledgling engineer Part 2
A memo for creating a python environment by a beginner
A memo about building a Django (Python) application with Docker
[Day 9] Creating a model
Creating a Home screen
4. Creating a structured program
A memorandum about matplotlib
[For memo] Linux Part 2
[Python] Memo about functions
List memo writing part 2
A memorandum about Nan.
Creating a scraping tool
Python basic memo --Part 2
A note about __call__
A note about subprocess
FastAPI Tutorial Memo Part 1
A note about mprotect (2)
Creating a dataset loader
Python basic memo --Part 1
PDF output with Latex extension in Sphinx
Memo about Sphinx Part 1 (Creating a project)
Number chapters and sections when PDF output (rst2pdf) with Sphinx
A story about creating a UNIX / Linux compatible OS from scratch
A memo when creating a directed graph using Graphviz in Python
A memo about the behavior of bowtie2 during multiple hits