Example: Docs as Code with Sphinx

Docs-as-Code (also known as "Documentation as Code") refers to the concept of treating documentation as a codebase, i.e. integrating the documentation process in the toolchains and workflows used by software development teams.

Docs-as-Code involves implementing versioning capabilities for your documentation projects and authoring your content with plain text markup languages such as Markdown or reStructuredText, among other things.

To find out more about Docs-as-Code, head over to the official website: https://docs-as-co.de/.

Whether you are a single technical communicator or a member of a larger documentation team, you can perfectly apply the Docs-as-Code approach to your documentation projects.

This guide will show you how to implement Docs-as-Code on a Linux machine using "Sphinx" as a documentation generator, "Git" as a version control system and "Codeberg Pages" as a static website hoster.

Note
Despite the fact that we are using Sphinx in this particular case, please note that you can easily apply the instructions provided below to any other static site generator (SSG) such as Eleventy or Hugo, etc.

Building documentation with Sphinx

Initially developed to generate Python documentation, Sphinx is now widely used by technical communicators and software developers to create technical and software documentation.

Sphinx uses reStructuredText as a markup language to generate documentation content. Among further advantages, Sphinx allows you to produce your documentation in different formats, including HTML, LaTeX and ePub. You can also use one of the multiple extensions developed by the community to extend its functionality.

Setting up the project

To begin setting up your project, you will first need an account on Codeberg. If you do not already have one, follow the instructions provided under Your First Steps on Codeberg.

This guide assumes that you already have Git installed on your machine. If this is not the case, please proceed as described in the article Install Git.

For the purpose of this guide, we will start a documentation project from scratch using an empty repository. To create a new, empty repository and clone it to your local workspace, follow the steps described in the article Your First Repository as well as the instructions provided under "Option A: Clone the newly created, empty repository" within the same article.

Creating a Python virtual environment

A "virtual" isolated environment comes in very handy to eliminate the risk of any broken dependencies while working on your projects. Put in other words, setting up a virtual environment for your project allows you to run an instance of the Python interpreter with a particular package set and a specific configuration while ensuring compatibility between all these components inside that environment.

Before proceeding with this task, you should make sure that you have "pip" and "python" installed on your machine. To perform a preliminary check, type the following commands in your terminal:

$ pip --version
$ python --version

If pip and Python are not already installed on your Linux machine, please follow the steps described in the articles pip Installation and Installing Python 3 on Linux respectively.

Depending on your Python version, you will need to install a compatible virtual environment manager, i.e. either "venv" for Python >= 3.3, or "virtualenv" for older Python versions.

Note
Please note that Python2 has reached its EOL (End of Life) on January 1st 2020, which means that it is no longer receiving any security updates. If you are using Python 3.3 or higher, you do not need to install the "venv" module, since it is already available in your Python standard library.

The next step consists in creating a virtual environment. To do so, navigate to the folder where you have cloned the repository described under the section Setting up the project:

$ cd ~/repositories/foobar
$ python3 -m venv env

You can replace the second argument "env" with any other name your like. This will be the folder hosting your virtual environment.

Important
Use a .gitignore file to exclude your virtual environment directory from your version control system. To ignore the entire "env" folder, you just have to include the corresponding path and append a / at its end, e.g. env/.

Activating the virtual environment

Before you begin performing any tasks on your project, you must activate your virtual environment by running the following command:

$ source env/bin/activate

To make sure that you are working inside your virtual environment, run the command:

$ which python

The output of the command above should be the env folder, e.g.:

$ ./env/bin/python

Whenever you are done working on your project, run the following command to leave the virtual environment:

$ deactivate

Installing Sphinx in your virtual environment

If you have followed the steps described up to this point, your local repository should now contain your virtual environment's folder env in addition to the hidden .git directory and the .gitignore file that we have already described at the end of the section Creating a Python virtual environment, e.g.:

├── myproject
│ ├── env
│ ├── .git
│ └── .gitignore

You will now create an empty directory then navigate to it. For the purpose of this guide, we will call our directory mydocs. Note that you can choose any other name you like:

$ mkdir mydocs
$ cd mydocs

Running the command tree -a should now give you the following output:

.
├── mydocs
├── env
├── .git
└── .gitignore

With your virtual environment activated as shown above, it is now time to install Sphinx with the pip tool. To do so, run the command:

(.venv) $ pip install -U sphinx

Note
If you want to find out what the different arguments of pip install do, type the command pip install -h in your terminal.

Once Sphinx is installed on your virtual environment, type the following command in your terminal:

(.venv) $ pip sphinx-quickstart

You will then be asked to answer a series of questions regarding the configuration of your project.
Confirm that you want to Separate source and build directories. For the rest of the questions, keep pressing Enter to accept the default values and fill out the requested fields until you reach the question autodoc: automatically insert docstrings from modules, then choose "y" (yes). Keep pressing Enter again until you reach the question Create Makefile? and select "y" (yes).

If you now run the tree command from your mydocs folder, you should get the following output:

.
├── build
├── make.bat
├── Makefile
└── source
├── conf.py
├── index.rst
├── _static
└── _templates

Congratulations! 🎉 You have just finished installing Sphinx on your Linux machine.

Running a local HTTP server using Python

To set up a local testing server for your documentation project, you can use the Python module http.server. To do so, you will first have to build the html resources for the initial test by running the command:

(.venv) $ sphinx-build -b html docs/source/ docs/build/html

Then navigate to the directory hosting the html resources:

(.venv) $ cd docs/build/html

Once there, run the local python server with the command:

(.venv) $ python3 -m http.server 8080

Note:
"8080" is the TCP port on which the host server is listening for requests.

To access the default index.html file, type http://localhost:8080 in your favorite browser. You should then see the default welcome page.

Creating files with reStructuredText and checking the output

You can start authoring your own content by creating a new reStructuredText file (.rst) in the source directory:

(.venv) $ cd mydocs/source
(.venv) $ touch mynewfile.rst

You have just created an empty ".rst" file with the touch command. An ".rst" file is simply a plain text file that is written with reStructuredText as a markup language. To learn about how to use reStructuredText, follow the instructions provided in the article reStructuredText Primer.

You will be more productive in your writing if you use a text editor that supports syntax highlighting such as Emacs or Atom. Linux offers plenty of powerful text editors that support syntax highlighting and other advanced features for coding and authoring tasks.

Note:
Whenever you create a new .rst file, you must add it manually to the toctree of your root document, i.e. "index.rst".

The toctree directive (toc stands for Table of Contents) inserts a tree that connects the different ".rst" files located in your source directory with each other. Read the article Directives to learn more about the toctree directive.

Once you have added an .rst file to the toctree, you can check the output at any time by running the sphinx-build command illustrated above, then refreshing your local testing server.

If you are satisfied with the result on your local development environment, you can publish the content on Codeberg Pages. To find out how to achieve this, read the article Pushing output from SSGs into Codeberg Pages.


Hey there! 👋 Thank you for reading this article!

Is there something missing or do you have an idea on how to improve the documentation? Do you want to write your own article?

You're invited to contribute to the Codeberg Documentation at its source code repository, for example by Adding a pull request or joining in on the discussion in the issue tracker.

For an introduction on contributing to Codeberg Documentation, please have a look at the Contributor FAQ.

© Codeberg Docs Contributors. See LICENSE