# srsRAN_4G_docs

**Repository Path**: rssdr/srsRAN_4G_docs

## Basic Information

- **Project Name**: srsRAN_4G_docs
- **Description**: Documentation for the srsRAN project
- **Primary Language**: C++
- **License**: AGPL-3.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2023-02-28
- **Last Updated**: 2023-03-01

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# srsRAN_docs
Documentation for the srsRAN project - see [docs.srsran.com](http://docs.srsran.com)

# Local Installation 

The docs require following Sphinx extensions:
- sphinxcontrib-seqdiag
- sphinxcontrib-blockdiag

On Ubuntu, they can be installed with:
```
sudo apt install python3-pip
pip3 install -r requirements.txt
```

Once dependenceies are installed,

```
git clone https://github.com/srsRAN/srsRAN_docs.git
cd srsRAN_docs/srsran_user_manuals
make html
```

Then load the compiled doc in your browser
```
firefox build/html/index.html
google-chrome build/html/index.html
```

To enable live build previews when editing documentation install the following extension: 
- sphinx-autobuild 

This can be installed from the requirements file. 
```
pip install -r requirements.txt
```

To build the docs first run from /srs_user_manuals/source
```
sphinx-build -b html . _build
```

Then run the following command from the docs main folder
```
sphinx-autobuild srsran_user_manuals/source/ srsran_user_manuals/source/_build/html
```
This will start a server at http://127.0.0.1:8000 which can be viewed in your browser, any changes to the docs will be shown here once saved.