Development

This page describes how to set up t-doc for development. It isn't necessary for creating and editing documents.

Install

• Install the required packages for your system.

• Clone the t-doc/common repository (substitute USER with your username).

  hg clone https://USER@c-space.net/rc/hg/t-doc/common
  cd common
  

• Enable git subrepositories.

  echo -e '[subrepos]\ngit:allowed = true\n' >> .hg/hgrc
  

• Checkout the subrepositories and activate the main bookmark.

  hg checkout main
  

• Install the t-doc-common package from editable sources.

  Windows

  python -m pip install --editable .
  

  macOS

  python -m pip install --user --editable .
  

  You may have to add $HOME/.local/bin to your PATH.

  Linux

  python -m pip install --user --editable .
  

  You may have to add $HOME/.local/bin to your PATH.

Upgrade

• Pull missing changesets from the t-doc/common repository.

  cd common
  hg pull
  

• Update to the branch head.

  hg update --check
  

• Upgrade the t-doc-common package metadata and any out-of-date dependencies.

  Windows

  python -m pip install --upgrade --editable .
  

  macOS

  python -m pip install --user --upgrade --editable .
  

  Linux

  python -m pip install --user --upgrade --editable .