Sphynx Docs setup

.tmuxp.yaml

session_name: PROJECT
environment:
    SPHINX_HOST: "0.0.0.0"
    SPHINX_PORT: "8000"
windows:
    - window_name: "Sphinx"
      layout: "main-vertical"
      start_directory: "${PWD}"
      focus: true
      panes:
        - shell_command:
            - source venv/bin/activate
            - cd docs
            - xdg-open http://$SPHINX_HOST:$SPHINX_PORT
            - make HOST=$SPHINX_HOST PORT=$SPHINX_PORT livehtml
        - focus: true
          shell_command:
            - cd docs/source
            - $EDITOR .

docs_setup.sh

pip install \
  sphinx \
  sphinx-autobuild \
  sphinx-autodoc-typehints \
  sphinx-rtd-theme \
  pydocstyle \
  doc8

Makefile

# Minimal makefile for Sphinx documentation
# Autobuild support

# You can set these variables from the command line.
SPHINXOPTS    =
SPHINXBUILD   = sphinx-build
SOURCEDIR     = source
BUILDDIR      = build
PORT          = 8000
HOST          = localhost

# Put it first so that "make" without argument is like "make help".
help:
	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

.PHONY: help Makefile

livehtml:
	sphinx-autobuild -H $(HOST) -p $(PORT)  -b html "$(SOURCEDIR)" "$(BUILDDIR)"/html $(SPHINXOPTS)

# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)