diff options
| author | Roberto Bertó <463349+robertoberto@users.noreply.github.com> | 2025-11-02 19:55:55 -0300 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2025-11-02 19:55:55 -0300 |
| commit | 6ca1269b138696b69c33d2db4bcf7dd03ea4caeb (patch) | |
| tree | 4c0a634730df2123ff506252cbec050de006dac8 /sphinx/README.md | |
| parent | 1ada32975f0bb559ec7526e0dd545700dde1cb94 (diff) | |
| parent | 6b4e9015744ab8c9f17a6b8e23387cd676b1d827 (diff) | |
| download | pyvyos-6ca1269b138696b69c33d2db4bcf7dd03ea4caeb.tar.gz pyvyos-6ca1269b138696b69c33d2db4bcf7dd03ea4caeb.zip | |
Merge pull request #27 from vyos-contrib/feat/architecture-and-quality-improvements
feat: v0.4.0 - Architecture refactor, bug fixes, and quality improvem…
Diffstat (limited to 'sphinx/README.md')
| -rw-r--r-- | sphinx/README.md | 27 |
1 files changed, 27 insertions, 0 deletions
diff --git a/sphinx/README.md b/sphinx/README.md new file mode 100644 index 0000000..813f05d --- /dev/null +++ b/sphinx/README.md @@ -0,0 +1,27 @@ +# Sphinx Documentation Builder + +This directory contains the Sphinx configuration for generating API documentation from Python docstrings. + +## Building Documentation + +To build the HTML documentation: + +```bash +cd sphinx +make html +``` + +The generated documentation will be in `sphinx/build/html/`. + +## Requirements + +Install Sphinx dependencies: + +```bash +pip install -r sphinx/requirements.txt +``` + +## Read the Docs + +This configuration is used by Read the Docs for automated documentation builds. + |