Skip to content

Commit

Permalink
instructions: build offline, local docs
Browse files Browse the repository at this point in the history
  • Loading branch information
eviau-artefactual committed Jun 27, 2024
1 parent 586fe79 commit aae0e5b
Showing 1 changed file with 28 additions and 0 deletions.
28 changes: 28 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,34 @@ You are free to copy, modify, and distribute the Archivematica 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:
`git clone https://github.com/artefactual/archivematica-docs.git`
- Move to the documentation repository with:
`cd archivematica-docs`
- Create a Python virtual environment to contain all the tools required to build the documentation:
`python3 -m venv .env`
- Activate the virtual environment:
`source .env/bin/activate`
- Install the requirements:
`pip install -r requirements.txt`
- Build the documentation:
`sphinx-build -D language=en ./ _build/html/en` for English
`sphinx-build -D language=es ./ _build/html/es` for *español* (Spanish)
`sphinx-build -D language=fr ./ _build/html/fr` for *français* (French)
`sphinx-build -D language=pt_BR ./ _build/html/pt_BR` for *português do Brasil* (Brazilian Portuguese)
- Access the documentation:
`open _build/html/index.html`

The HTML files for the documentation will be in `archivematica-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.

## Contributing

Thank you for considering a contribution to the Archivematica documentation! For
Expand Down

0 comments on commit aae0e5b

Please sign in to comment.