62 lines
1.6 KiB
Markdown
62 lines
1.6 KiB
Markdown
# Streamlit Dashboard Documentation
|
|
|
|
This project uses [Sphinx](https://www.sphinx-doc.org/) 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:**
|
|
```bash
|
|
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:**
|
|
```bash
|
|
..\venv\Scripts\activate
|
|
```
|
|
|
|
Once activated, verify Sphinx is available:
|
|
|
|
```bash
|
|
sphinx-build --version
|
|
```
|
|
|
|
## Building the Documentation
|
|
|
|
To build the HTML documentation, follow these steps:
|
|
|
|
1. Navigate to the `docs` directory:
|
|
```bash
|
|
cd docs
|
|
```
|
|
|
|
2. Run the make command for HTML:
|
|
* **On Linux/macOS:**
|
|
```bash
|
|
make html
|
|
```
|
|
* **On Windows:**
|
|
```bash
|
|
.\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:
|
|
|
|
```bash
|
|
sphinx-apidoc -o docs/ .
|
|
```
|
|
|
|
After updating the `.rst` files, rebuild the HTML documentation as described above.
|