Getting Started =============== Welcome to the Test Documentation getting started guide! Prerequisites ------------- Before you begin, ensure you have: * Python 3.8 or higher * pip package manager * Basic knowledge of command line Installation ------------ Install Sphinx and required dependencies: .. code-block:: bash pip install sphinx sphinx-rtd-theme sphinx-autobuild Project Setup ------------- 1. Create a new directory for your documentation: .. code-block:: bash mkdir my-docs cd my-docs 2. Run Sphinx quickstart: .. code-block:: bash sphinx-quickstart 3. Configure your ``conf.py`` file with the RTD theme Writing Documentation --------------------- Sphinx uses reStructuredText (.rst) format. Here are some common elements: Headers ^^^^^^^ .. code-block:: rst Main Title ========== Section ------- Subsection ^^^^^^^^^^ Lists ^^^^^ **Bullet List:** * First item * Second item * Third item **Numbered List:** 1. First step 2. Second step 3. Third step Code Blocks ^^^^^^^^^^^ You can include code snippets: .. code-block:: python def hello_world(): """Simple hello world function.""" print("Hello, World!") return True Links ^^^^^ * External link: `Sphinx Documentation `_ * Internal reference: :doc:`api-reference` Next Steps ---------- Now that you have the basics, explore: * :doc:`api-reference` - Learn about API documentation * :doc:`examples` - See practical examples * :doc:`faq` - Common questions and answers