Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add instructions: offline docs #292

Merged
merged 3 commits into from
Jul 24, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
Loading