Digital Development Docs Hub

Documentation Hub aims to collect all of the documentation created by Digital Development into a single location.

Source Code

The source code is available in Azure Devops. To clone, make sure that the submodules are also checked out. One way to do it is by executing the command below to check out everything.

bash git clone --recurse-submodules --shallow-submodules <repository>

Dependencies

The documentation is generated using Python with MkDocs. From a Python environment, the dependencies can be installed using the requirements.txt file.

bash pip install -r requirements.txt

Build

MkDocs provides a CLI to build the documentation.

bash mkdocs build

For an interactive development, the MkDocs server can be used to see the changes in real time

bash mkdocs serve