Documentation WIP.

redcode · Oct 29, 2024 · ca2af64 · ca2af64
1 parent f4988f4
commit ca2af64
Show file tree

Hide file tree

Showing 12 changed files with 15 additions and 70 deletions.
diff --git a/documentation/Makefile b/documentation/Makefile
diff --git a/documentation/APIReference.rst → documentation/api-reference.rst b/documentation/APIReference.rst → documentation/api-reference.rst
diff --git a/documentation/index.rst b/documentation/index.rst
@@ -10,14 +10,14 @@ Contents
 .. toctree::
    :maxdepth: 2
 
-   Introduction
-   InstallationFromSources
-   Tests
-   Integration
-   Usage
-   APIReference
-   Thanks
-   VersionHistory
-   License
+   introduction
+   installation-from-sources
+   tests
+   integration
+   usage
+   api-reference
+   thanks
+   version-history
+   license
    genindex
    search
diff --git a/documentation/InstallationFromSources.rst → documentation/installation-from-sources.rst b/documentation/InstallationFromSources.rst → documentation/installation-from-sources.rst
@@ -75,7 +75,7 @@ Package-specific options are prefixed with ``Z80_`` and can be divided into two
 
 .. option:: -DZ80_DEPOT_LOCATION="<location>"
 
-   Specify the directory or URL of the depot containing the test files (i.e., the firmware and software required by the :doc:`testing tool <Tests>`). |br| |nl|
+   Specify the directory or URL of the depot containing the test files (i.e., the firmware and software required by the :doc:`testing tool <tests>`). |br| |nl|
    The default is ``"http://zxe.io/depot"``.
 
 .. option:: -DZ80_FETCH_TEST_FILES=(YES|NO)
@@ -144,7 +144,7 @@ Package-specific options are prefixed with ``Z80_`` and can be divided into two
 
 .. option:: -DZ80_WITH_TESTS=(YES|NO)
 
-   Build the :doc:`testing tool <Tests>`. |br| |nl|
+   Build the :doc:`testing tool <tests>`. |br| |nl|
    The default is ``NO``.
 
 .. _cmake_package_source_code_options:

diff --git a/documentation/Integration.rst → documentation/integration.rst b/documentation/Integration.rst → documentation/integration.rst
@@ -72,7 +72,7 @@ The source code of the emulator can be configured at compile time by predefining
 
    Tells :file:`Z80.c` to ``#include "Z80.h"`` instead of ``<Z80.h>``.
 
-The :ref:`optional features <Introduction:Optional features>` of the emulator mentioned in the ":doc:`InstallationFromSources`" section are disabled by default. If you compile :file:`Z80.c` as a part of your project, enable those features you need by predefining their respective activation macros. They have the same name as their :ref:`CMake equivalents <cmake_package_source_code_options>`:
+The :ref:`optional features <Introduction:Optional features>` of the emulator mentioned in the ":doc:`installation-from-sources`" section are disabled by default. If you compile :file:`Z80.c` as a part of your project, enable those features you need by predefining their respective activation macros. They have the same name as their :ref:`CMake equivalents <cmake_package_source_code_options>`:
 
 .. c:macro:: Z80_WITH_EXECUTE
 

diff --git a/documentation/Introduction.rst → documentation/introduction.rst b/documentation/Introduction.rst → documentation/introduction.rst
diff --git a/documentation/License.rst → documentation/license.rst b/documentation/License.rst → documentation/license.rst
diff --git a/documentation/make.bat b/documentation/make.bat
diff --git a/documentation/Tests.rst → documentation/tests.rst b/documentation/Tests.rst → documentation/tests.rst
diff --git a/documentation/Thanks.rst → documentation/thanks.rst b/documentation/Thanks.rst → documentation/thanks.rst
diff --git a/documentation/Usage.rst → documentation/usage.rst b/documentation/Usage.rst → documentation/usage.rst
diff --git a/documentation/VersionHistory.rst → documentation/version-history.rst b/documentation/VersionHistory.rst → documentation/version-history.rst
@@ -11,7 +11,7 @@ This is an important update that addresses a number of issues and also includes
 
 **Changes:**
 
-1. Changed the :doc:`license <License>` from GPL to LGPL (by popular request).
+1. Changed the :doc:`license <license>` from GPL to LGPL (by popular request).
 2. Moved the public header from ``<emulation/CPU/Z80.h>`` to ``<Z80.h>``.
 3. Removed the Xcode project.
 4. Switched the build system from Premake to `CMake <https://cmake.org>`_.
@@ -22,7 +22,7 @@ This is an important update that addresses a number of issues and also includes
 9. Added Pascal binding, courtesy of Zoran Vučenović.
 10. Added tests.
 11. Renamed the macros ``CPU_Z80_DEPENDENCIES_H`` and ``CPU_Z80_STATIC`` to :c:macro:`Z80_EXTERNAL_HEADER` and :c:macro:`Z80_STATIC`, respectively.
-12. Added :ref:`public macros <APIReference:Macros>` for checking the library version, working with flags, accessing the 16-bit registers and other purposes.
+12. Added :ref:`public macros <api-reference:Macros>` for checking the library version, working with flags, accessing the 16-bit registers and other purposes.
 13. Added the ability to end the emulation loop immediately, and the :c:func:`z80_break` function.
 14. Added the :c:func:`z80_execute` function for running a simplified emulation without RESET and interrupts.
 15. Added the :c:func:`z80_in_cycle` and :c:func:`z80_out_cycle` functions for obtaining the clock cycle at which the I/O M-cycle begins, relative to the start of the instruction.
@@ -37,7 +37,7 @@ This is an important update that addresses a number of issues and also includes
 24. Added four callbacks for notifying the execution of important instructions: :c:data:`Z80::ld_i_a<Z80.ld_i_a>`, :c:data:`Z80::ld_r_a<Z80.ld_r_a>`, :c:data:`Z80::reti<Z80.reti>` and :c:data:`Z80::retn<Z80.retn>`.
 25. Added hooking functionality through the ``ld h,h`` instruction and the new :c:data:`Z80::hook<Z80.hook>` callback.
 26. Added the :c:data:`Z80::illegal<Z80.illegal>` callback for delegating the emulation of illegal instructions.
-27. Added :ref:`emulation options <APIReference:Configuration>` that can be configured at runtime.
+27. Added :ref:`emulation options <api-reference:Configuration>` that can be configured at runtime.
 28. Removed ``Z80::state``. Replaced with individual members for the registers, the interrupt enable flip-flops and the interrupt mode.
 29. Removed the superfluous EI flag. The previous opcode is checked instead, which is faster and makes the :c:type:`Z80` object smaller.
 30. Removed all module-related stuff.