From bc7c04f2813392c0ef1aedff25ab0daaadc87c7e Mon Sep 17 00:00:00 2001 From: eviau-artefactual Date: Mon, 8 Jul 2024 15:47:31 -0400 Subject: [PATCH 1/4] ignore virtual env --- .gitignore | 1 + 1 file changed, 1 insertion(+) diff --git a/.gitignore b/.gitignore index cbe989b..bd3a388 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,4 @@ /_build *.DS_Store *~ +.env/ From b589b497bd7e4c9eda419d0bc756540eea3ef6ad Mon Sep 17 00:00:00 2001 From: eviau-artefactual Date: Mon, 8 Jul 2024 15:54:43 -0400 Subject: [PATCH 2/4] Instructions for offline, local docs --- README.md | 62 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 62 insertions(+) diff --git a/README.md b/README.md index 451f985..753576a 100644 --- a/README.md +++ b/README.md @@ -13,6 +13,68 @@ documentation with attribution under the terms of the Creative Commons Attribution Share Alike 4.0 (CC-BY-SA-4.0) license. See the [LICENCE](LICENCE) file for details. +## Building the documentation locally + +To build a local, offline version of the documentation: + +* Decide where the documentation will be stored on your computer. +* In a Terminal window, use the `cd` command to navigate to this location. +* Create a local copy of the documentation by running: + +```bash +git clone https://github.com/artefactual/archivematica-storage-service-docs.git +``` + +* Move to the documentation repository with: + +```bash +cd archivematica-storage-service-docs +``` + +* Create a Python virtual environment to contain all the required tools: + +```bash +python3 -m venv .env +``` + +* Activate the virtual environment: + +```bash +source .env/bin/activate +``` + +* Install the requirements: + +```bash +pip install -r requirements.txt +``` + +* Build the documentation: + +```bash +sphinx-build -D language=en ./ _build/html/en # for English +``` + +* Access the documentation: + +```bash +open _build/html/ +``` + +The HTML files for the documentation will be in +`archivematica-storage-service-docs/_build/html/`. +You can open the files in a browser of your choice, without having any access +to the Internet. + +While this offline version will not have the Archivematica web theme, you will +gain access to improved search features. + +This local version will contain only the Archivematica Storage Service +documentation; notably the Archivematica docs will be missing. Instructions on +how to build a local, offline version of the Archivematica is available on its +[GitHub repo](https://github.com/artefactual/archivematica-docs). + + ## Contributing Thank you for considering a contribution to the Archivematica Storage Service From c403bd302d5cfb97eb4ebd7c650aaac97834de9e Mon Sep 17 00:00:00 2001 From: eviau-artefactual Date: Mon, 8 Jul 2024 15:57:56 -0400 Subject: [PATCH 3/4] linting --- README.md | 1 - 1 file changed, 1 deletion(-) diff --git a/README.md b/README.md index 753576a..654aa17 100644 --- a/README.md +++ b/README.md @@ -74,7 +74,6 @@ documentation; notably the Archivematica docs will be missing. Instructions on how to build a local, offline version of the Archivematica is available on its [GitHub repo](https://github.com/artefactual/archivematica-docs). - ## Contributing Thank you for considering a contribution to the Archivematica Storage Service From 60e11f0935b5eb7ee5067d64bcd41d52fe780c6c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=89dith?= <146032034+eviau-artefactual@users.noreply.github.com> Date: Mon, 8 Jul 2024 16:18:33 -0400 Subject: [PATCH 4/4] Update README.md Co-authored-by: Douglas Cerna --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 654aa17..90a71be 100644 --- a/README.md +++ b/README.md @@ -71,7 +71,7 @@ gain access to improved search features. This local version will contain only the Archivematica Storage Service documentation; notably the Archivematica docs will be missing. Instructions on -how to build a local, offline version of the Archivematica is available on its +how to build a local, offline version of the Archivematica docs is available on its [GitHub repo](https://github.com/artefactual/archivematica-docs). ## Contributing