Streamlit Dashboard Documentation

This project uses Sphinx to generate its technical documentation from docstrings in the source code.

Prerequisites

Before building the documentation, ensure you have activated the virtual environment located in the parent directory, as it contains all the necessary dependencies (including Sphinx, Streamlit, etc.).

Activating the Virtual Environment

On Linux/macOS:
```
source ../venv/bin/activate
```
(Note: Replace venv with the actual name of the virtual environment folder if it differs, e.g., .venv or env.)
On Windows:
```
..\venv\Scripts\activate
```

Once activated, verify Sphinx is available:

sphinx-build --version

Building the Documentation

To build the HTML documentation, follow these steps:

Navigate to the docs directory:
```
cd docs
```
Run the make command for HTML:
- On Linux/macOS:
```
make html
```
- On Windows:
```
.\make.bat html
```

Viewing the Documentation

Once the build is complete, you can find the generated HTML files in the docs/_build/html directory.

To view the documentation, open docs/_build/html/index.html in your web browser.

Updating the Documentation

If you add new modules or packages to the project, you may need to regenerate the .rst files using sphinx-apidoc. From the project root, you can run:

sphinx-apidoc -o docs/ .

After updating the .rst files, rebuild the HTML documentation as described above.

1.6 KiB Raw Permalink Blame History