From b109578ec1e8635aeb9f12c3a913108232347935 Mon Sep 17 00:00:00 2001 From: Théo de la Hogue Date: Tue, 6 Jun 2023 17:46:24 +0200 Subject: Working on documentation architecture. --- docs/contributor_guide/build_documentation.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) create mode 100644 docs/contributor_guide/build_documentation.md (limited to 'docs/contributor_guide/build_documentation.md') diff --git a/docs/contributor_guide/build_documentation.md b/docs/contributor_guide/build_documentation.md new file mode 100644 index 0000000..20df1df --- /dev/null +++ b/docs/contributor_guide/build_documentation.md @@ -0,0 +1,23 @@ +Build documentation +=================== + +ArGaze has a standard MkDocs layout which is built by Read the Docs. You can build and view this documentation project locally. + +!!! note + + *Consider that all inline commands below have to be executed into ArGaze root folder.* + +Install required Python dependencies (MkDocs etc.): +```console +pip install -r docs/requirements.in +``` + +Run the mkdocs development server: +```console +mkdocs serve +``` + +Export the mkdocs site: +```console +mkdocs build +``` -- cgit v1.1