mirror of
https://github.com/kevinveenbirkenbach/computer-playbook.git
synced 2025-09-10 20:37:15 +02:00
Optimized Documentation about Sphinx and created Makefile in root
This commit is contained in:
25
sphinx/README.md
Normal file
25
sphinx/README.md
Normal file
@@ -0,0 +1,25 @@
|
||||
# Documentation
|
||||
|
||||
CyMaIS uses [Sphinx](https://www.sphinx-doc.org/) to automatically generate its documentation and leverages the [Awesome Sphinx Theme](https://sphinxawesome.xyz/) for a sleek and responsive design. Enjoy a seamless, visually engaging experience 🚀✨.
|
||||
|
||||
## For Users
|
||||
|
||||
You can access the documentation [here](https://docs.cymais.cloud/) 🔗. Browse the latest updates and guides to get started.
|
||||
|
||||
## For Administrators
|
||||
|
||||
### Setup
|
||||
|
||||
#### On Localhost
|
||||
|
||||
To generate the documentation locally, run the following command:
|
||||
|
||||
```bash
|
||||
pkgmgr shell cymais -c "make refresh"
|
||||
```
|
||||
|
||||
This command cleans the previous build and generates the updated documentation. Once complete, you can view it at the output location (e.g., [templates/html/index.html](templates/html/index.html)) 👀💻.
|
||||
|
||||
#### On Server
|
||||
|
||||
In your inventory file, enable the **Sphinx** role. When activated, the documentation will be automatically generated and deployed under the **docs** subdomain of your CyMaIS instance. This ensures your documentation is always current and easily accessible 🔄🌐.
|
@@ -40,10 +40,12 @@
|
||||
|
||||
{% if local_md_headings or local_subfolders %}
|
||||
<div class="local-md-headings">
|
||||
<h3 class="toctree-l1">Index</h3>
|
||||
<h3>Overview</h3>
|
||||
<h4 class="toctree-l1">Current Index</h3>
|
||||
{% if local_md_headings %}
|
||||
{{ render_headings(local_md_headings) }}
|
||||
{% endif %}
|
||||
<h4 class="toctree-l1">File Explorer</h3>
|
||||
{% if local_subfolders %}
|
||||
{{ render_headings(local_subfolders) }}
|
||||
{% endif %}
|
||||
|
Reference in New Issue
Block a user