.. _chapter_sphinx:


Sphinx Documentation
====================

README
------

For quick start, installation, usage, and contribution guidelines, see :doc:`Documents/sphinx_readme` - the complete user guide for the dingx Sphinx documentation repository.

|

CLAUDE Quick Reference
----------------------

For development with Claude Code, see :doc:`Documents/sphinx_claude` - a comprehensive guide on project structure, configuration, JIRA integration, common workflows, and important conventions for AI-assisted development.

.. toctree::
   :maxdepth: 1
   :hidden:

   Documents/sphinx_readme
   Documents/sphinx_claude
   Documents/jira_sphinxneeds_sync
   Documents/jira_sphinx_sync
   Documents/jira_config_ref
   Documents/vm_deployment_guide

|

Apple Script
------------

The apple script `Script Sphinx dingx Docu <https://drive.google.com/open?id=1vI3pP9WR7AqkX1gVSCW1smoD8mi01V7X&usp=drive_fs>`__ creates the different build versions.

|

JIRA Integration
----------------

This Sphinx documentation system includes bidirectional synchronization with JIRA for task management:

- :doc:`Documents/jira_sphinxneeds_sync` - Guide to JIRA ↔ Sphinx-Needs synchronization
- :doc:`Documents/jira_sphinx_sync` - Documentation for JIRA synchronization
- :doc:`Documents/jira_config_ref` - JIRA configuration reference and :ref:`jade.yml <jira_jade_yml>` documentation

|

VM Deployment
-------------

Guide for deploying and managing the Sphinx documentation on Google Cloud virtual machines:

- :doc:`Documents/vm_deployment_guide` - Complete VM deployment guide

|

.. _sphinx_conf_py:

Settings
--------

The settings are defined in the **conf.py** file which is in the root directory of the Sphinx implementation:

.. literalinclude:: ../../conf.py
   :language: py
   :caption: conf.py

|

.. _sphinx_makefile:

Build Automation
----------------

The **Makefile** provides build automation commands for generating documentation in multiple formats and managing JIRA synchronization:

.. literalinclude:: ../../../Makefile
   :language: makefile
   :caption: Makefile