Skip to content

Commit

Permalink
Add instructions: offline docs (#292)
Browse files Browse the repository at this point in the history
  • Loading branch information
eviau-artefactual authored Jul 24, 2024
1 parent 3e83090 commit 9a365f4
Showing 1 changed file with 56 additions and 0 deletions.
56 changes: 56 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,62 @@ You are free to copy, modify, and distribute the AtoM 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/atom-docs.git
```

* Move to the documentation repository with:

```bash
cd atom-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
python3 -m http.server -d _build/html/
```

The HTML files for the documentation will be in
`atom/_build/html/`.
You can open the files in a browser of your choice, without having any access
to the Internet, by accessing `http://localhost:8000`.

While this offline version will not have the AtoM web theme, you will
gain access to improved search features.

## Contributing

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

0 comments on commit 9a365f4

Please sign in to comment.