diff --git a/documentation/Makefile b/documentation/Makefile deleted file mode 100644 index d4bb2cbb..00000000 --- a/documentation/Makefile +++ /dev/null @@ -1,20 +0,0 @@ -# Minimal makefile for Sphinx documentation -# - -# You can set these variables from the command line, and also -# from the environment for the first two. -SPHINXOPTS ?= -SPHINXBUILD ?= sphinx-build -SOURCEDIR = . -BUILDDIR = _build - -# Put it first so that "make" without argument is like "make help". -help: - @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) - -.PHONY: help Makefile - -# Catch-all target: route all unknown targets to Sphinx using the new -# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). -%: Makefile - @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) diff --git a/documentation/APIReference.rst b/documentation/api-reference.rst similarity index 100% rename from documentation/APIReference.rst rename to documentation/api-reference.rst diff --git a/documentation/index.rst b/documentation/index.rst index 749f1e95..d963b74f 100644 --- 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 b/documentation/installation-from-sources.rst similarity index 99% rename from documentation/InstallationFromSources.rst rename to documentation/installation-from-sources.rst index 56a7c961..1eae69a0 100644 --- a/documentation/InstallationFromSources.rst +++ b/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="" - Specify the directory or URL of the depot containing the test files (i.e., the firmware and software required by the :doc:`testing tool `). |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 `). |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 `. |br| |nl| + Build the :doc:`testing tool `. |br| |nl| The default is ``NO``. .. _cmake_package_source_code_options: diff --git a/documentation/Integration.rst b/documentation/integration.rst similarity index 94% rename from documentation/Integration.rst rename to documentation/integration.rst index b3d71518..062d97a6 100644 --- a/documentation/Integration.rst +++ b/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 ````. -The :ref:`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 `: +The :ref:`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 `: .. c:macro:: Z80_WITH_EXECUTE diff --git a/documentation/Introduction.rst b/documentation/introduction.rst similarity index 100% rename from documentation/Introduction.rst rename to documentation/introduction.rst diff --git a/documentation/License.rst b/documentation/license.rst similarity index 100% rename from documentation/License.rst rename to documentation/license.rst diff --git a/documentation/make.bat b/documentation/make.bat deleted file mode 100644 index 2119f510..00000000 --- a/documentation/make.bat +++ /dev/null @@ -1,35 +0,0 @@ -@ECHO OFF - -pushd %~dp0 - -REM Command file for Sphinx documentation - -if "%SPHINXBUILD%" == "" ( - set SPHINXBUILD=sphinx-build -) -set SOURCEDIR=. -set BUILDDIR=_build - -if "%1" == "" goto help - -%SPHINXBUILD% >NUL 2>NUL -if errorlevel 9009 ( - echo. - echo.The 'sphinx-build' command was not found. Make sure you have Sphinx - echo.installed, then set the SPHINXBUILD environment variable to point - echo.to the full path of the 'sphinx-build' executable. Alternatively you - echo.may add the Sphinx directory to PATH. - echo. - echo.If you don't have Sphinx installed, grab it from - echo.http://sphinx-doc.org/ - exit /b 1 -) - -%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% -goto end - -:help -%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% - -:end -popd diff --git a/documentation/Tests.rst b/documentation/tests.rst similarity index 100% rename from documentation/Tests.rst rename to documentation/tests.rst diff --git a/documentation/Thanks.rst b/documentation/thanks.rst similarity index 100% rename from documentation/Thanks.rst rename to documentation/thanks.rst diff --git a/documentation/Usage.rst b/documentation/usage.rst similarity index 100% rename from documentation/Usage.rst rename to documentation/usage.rst diff --git a/documentation/VersionHistory.rst b/documentation/version-history.rst similarity index 95% rename from documentation/VersionHistory.rst rename to documentation/version-history.rst index c53ce0a1..d6657305 100644 --- a/documentation/VersionHistory.rst +++ b/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 ` from GPL to LGPL (by popular request). +1. Changed the :doc:`license ` from GPL to LGPL (by popular request). 2. Moved the public header from ```` to ````. 3. Removed the Xcode project. 4. Switched the build system from Premake to `CMake `_. @@ -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 ` for checking the library version, working with flags, accessing the 16-bit registers and other purposes. +12. Added :ref:`public 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`, :c:data:`Z80::ld_r_a`, :c:data:`Z80::reti` and :c:data:`Z80::retn`. 25. Added hooking functionality through the ``ld h,h`` instruction and the new :c:data:`Z80::hook` callback. 26. Added the :c:data:`Z80::illegal` callback for delegating the emulation of illegal instructions. -27. Added :ref:`emulation options ` that can be configured at runtime. +27. Added :ref:`emulation options ` 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.