README.md

# JAWS Documentation

## Repository for JAWS docs

This content was created by using sphinx and hosted by [readthedocs](https://sphinx-rtd-theme.readthedocs.io/en/stable/index.html).

### Install sphinx

```
apt-get install python3-sphinx ## Linux
brew install sphinx-doc ## macOS
```

### Create `conda env`

```
conda create --name sphinx
conda activate sphinx
pip install sphinx
pip install recommonmark
pip install -U sphinxcontrib-confluencebuilder
pip install sphinx_rtd_theme 
pip install sphinx-panels
```
  
### Sphinx Tutorials

- Follow sphinx tutorial in [readthedocs.org](https://docs.readthedocs.io/en/latest/intro/getting-started-with-sphinx.html).

Sphinx uses [reStructuredText](http://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html).

### Create Initial Directory Structure

```
sphinx-quickstart
```

Now start adding content to the pages...


### Build `html` from source (`rst` or `md`) files

```
make html
```

### Quick View

```
open build/html/index.html
make clean
```

Once you are satisfied, add changes to this gitlab repo. 


## Register gitlab with readthedocs

https://docs.readthedocs.io/en/latest/intro/getting-started-with-sphinx.html

## View published docs

https://jaws-docs.readthedocs.io/en/latest/

## Publish BETA Documentation
To publish a draft version of the documentation, push your changes to the `beta` branch. This will trigger a pipeline that automatically publishes the documentation as a `BETA` version, which can be viewed at: https://jaws-docs.readthedocs.io/en/beta.

We maintain two versions of the documentation:

- `latest` — reflects the main branch (production-ready version).
- `beta` — reflects the beta branch (for testing and previewing changes).

For testing purposes, always push changes to the beta branch. Once the changes are verified, merge them into the main branch, and the latest version will be automatically updated and deployed.