Sphinx install

OS Installs

pip install sphinx  # pip
pacman -S sphinx    # archlinux

sphinx-quickstart   # setup wizard

Environment Installs

Nix

${package}/default.nix

# ${package}/default.nix

# Defines minimal env to run code/tests within interpreter.
# (optionally, override with your preferred packages in with a `shell.nix`)
#
# If you just want to run tests, use `python setup.py test`.
# See https://nixos.org/features.html
#
# Run:
#    nix-shell

{ 
  pkgs ? import <nixpkgs> {}, 
  mach-nix ? import (builtins.fetchGit { url = "https://github.com/DavHau/mach-nix/"; ref = "refs/tags/3.1.1"; }) { python = "python38"; },
  extra_python_requirements ? []
}:

let
  python_requirements = 
    pkgs.lib.strings.splitString "\n" (builtins.readFile ./requirements.txt)
    ++ extra_python_requirements;

  python = (mach-nix.mkPython {
    requirements = (pkgs.lib.strings.concatStrings (map(x: "${x}\n") python_requirements));
  });

in
  pkgs.stdenv.mkDerivation {
    name = "taskmage-0.0.1";
    buildInputs = [
      pkgs.hello
      python
    ];
  }

${package}/shell.nix

# vim: ft=nix
#
# Overrides default.nix, for inserting your own development tools.
#
# INSTRUCTIONS:
#   Copy this file to `shell.nix` and alter with desired packages.
#
# RUN:
#   nix-shell

{ pkgs ? import <nixpkgs> {} }:

let
  extra-os-packages = pkgs.config.vim-base;            # ex: [ neovim ripgrep ]

  mach-nix = import 
    (builtins.fetchGit { url = "https://github.com/DavHau/mach-nix/"; ref = "refs/tags/3.1.1"; }) 
    { python = "python38"; };

  pkg = import ./default.nix { 
    mach-nix = mach-nix; 
  };

in
  pkg.overrideAttrs(
    old: { 
      buildInputs = old.buildInputs ++ extra-os-packages;
    }
  )

${package}/requirements.txt

sphinx