switch back to sphinx + some new events

Author: anandsshah

README.md

@@ -9,7 +9,7 @@ It also has useful utilities like:
 * Creating a ZIP looped package from an FLP
 
 ## Usage
-```Python
+```{code-block} python
 from pyflp.parser import ProjectParser
 project = ProjectParser().parse("/path/to/efelpee.flp")
 
@@ -18,12 +18,12 @@ project = ProjectParser().parse("/path/to/efelpee.flp")
 
 ## Installation
 
-```
+```{code-block}
 pip install pyflp
 ```
 
 ## Testing
-I have created a [null test](test_parser.py). More tests need to be added.
+I have created a [null test](tests/test_parser.py). More tests need to be added.
 
 ## Thanks
 
@@ -33,4 +33,4 @@ I have created a [null test](test_parser.py). More tests need to be added.
 
 ## Contributions
 
-If you can spare some time for testing and/or contributing, I would be very grateful. Please check the [TODO](../TODO) as well for current goals/issues. You can reach me at **demberto**[at]**protonmail**[dot]**com** as well :)
+If you can spare some time for testing and/or contributing, I would be very grateful. Please check the [TODO](TODO.md) as well for current goals/issues. You can reach me at **demberto**[at]**protonmail**[dot]**com** as well :)

docs/Makefile

@@ -0,0 +1,20 @@
+# 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)

docs/conf.py

@@ -0,0 +1,61 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# This file only contains a selection of the most common options. For a full
+# list see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Path setup --------------------------------------------------------------
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+import os
+import sys
+sys.path.insert(0, os.path.abspath('..'))
+
+
+# -- Project information -----------------------------------------------------
+
+project = 'PyFLP'
+copyright = '2021, demberto'
+author = 'demberto'
+
+# The full version, including alpha/beta/rc tags
+release = '0.0.3'
+
+
+# -- General configuration ---------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+    'sphinx.ext.napoleon',
+    'sphinx.ext.todo',
+    'sphinx.ext.autodoc',
+    'sphinx.ext.githubpages',
+    'sphinx.ext.viewcode',
+    'myst_parser'
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = 'sphinx_rtd_theme'
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']

docs/flp-format.md

@@ -10,7 +10,7 @@ data        # [size, type depends on id] Either a fixed size event or a variable
 
 *where type of `data` is decided by*
 
-```Python
+```{code-block} python
 if event_id in range(0, 64):
     data.size = 1       # Hence event size = 2 ("ByteEvent" from here on)
 elif event_id in range(64, 128):

docs/how-does-it-work.md

@@ -8,7 +8,7 @@ Since, FLP is an event-based binary format, we need to work with data types of C
 
 Then I read all the events into a `list` of `Event` objects which I call the **Event Store**. The parsing logic for this is in [`_build_event_store()`](../pyflp/parser.py#L78) method of `ProjectParser`. It is important that every new event has an `index` so it can be sorted later on, while saving. The `Event` class and its subclasses `ByteEvent`, `WordEvent`, `DWordEvent`, `TextEvent`, and `DataEvent` look like this *minified*:
 
-```Python
+```{code-block} python
 class Event:
     def __init__(self, id, data):
         self.id = id
@@ -33,7 +33,8 @@ Subclasses have additional `to_*` helper methods, which convert basic types to P
 Once the events are created, the `ProjectParser.parse()` starts building the `Project` object, by examining `Event` IDs. All its fields for e.g. `Channel`, `Insert` etc. inherit from `FLObject`.
 
 FLObject class looks like this *minified*:
-```Python
+
+```{code-block} python
 class FLObject:
     def __init__(self):
         self._events: Dict[str, Event] = {}

docs/index.html

@@ -0,0 +1,22 @@
+.. PyFLP documentation master file, created by
+   sphinx-quickstart on Fri Sep 24 18:29:27 2021.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to PyFLP's documentation!
+=================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   README <readme_link.md>
+   FLP Format <flp-format.md>
+   Modules <modules.rst>
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

docs/index.rst

@@ -0,0 +1,35 @@
+@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.https://www.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

docs/make.bat

@@ -0,0 +1,7 @@
+pyflp
+=====
+
+.. toctree::
+   :maxdepth: 4
+
+   pyflp

docs/modules.rst

@@ -0,0 +1,61 @@
+pyflp.event package
+===================
+
+Submodules
+----------
+
+pyflp.event.byte\_event module
+------------------------------
+
+.. automodule:: pyflp.event.byte_event
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+pyflp.event.data\_event module
+------------------------------
+
+.. automodule:: pyflp.event.data_event
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+pyflp.event.dword\_event module
+-------------------------------
+
+.. automodule:: pyflp.event.dword_event
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+pyflp.event.event module
+------------------------
+
+.. automodule:: pyflp.event.event
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+pyflp.event.text\_event module
+------------------------------
+
+.. automodule:: pyflp.event.text_event
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+pyflp.event.word\_event module
+------------------------------
+
+.. automodule:: pyflp.event.word_event
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: pyflp.event
+   :members:
+   :undoc-members:
+   :show-inheritance: