Removed pdoc and setup Sphinx. (#49)

.github/workflows/sphinx-pr.yml

@@ -0,0 +1,19 @@
+name: "Pull Request Docs Check"
+on:
+  - pull_request
+
+jobs:
+  docs:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout the PR
+        uses: actions/checkout@v2
+      - name: Build Sphinx docs
+        uses: ammaraskar/sphinx-action@master
+        with:
+          docs-folder: "docs/"
+      - name: Upload HTML artifact
+        uses: actions/upload-artifact@v1
+        with:
+          name: DocumentationHTML
+          path: docs/build/html/

README.md

@@ -20,4 +20,4 @@ You can also clone the repo and run the following command in the project root to
     $ pip install -e .
 
 ## Documentation
-The documentation for pymkv can be found in the [here](https://pymkv.shel.dev/).
+The documentation for pymkv can be found [here](https://pymkv.shel.dev) or in the docstrings.

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     = source
+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/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+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

docs/requirements.txt

@@ -0,0 +1,7 @@
+# project dependencies
+bitmath
+iso-639
+
+# doc dependencies
+Sphinx ~= 2.4
+sphinx_rtd_theme

docs/source/conf.py

@@ -0,0 +1,60 @@
+# 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:
+# http://www.sphinx-doc.org/en/master/config
+
+# -- 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 = 'pymkv'
+copyright = '2020, Sheldon Woodward'
+author = 'Sheldon Woodward'
+
+# The full version, including alpha/beta/rc tags
+release = '1.0.6'
+
+
+# -- 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.autodoc',
+    'sphinx.ext.coverage',
+    'sphinx.ext.napoleon'
+]
+
+# 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 = []
+
+master_doc = 'index'
+
+
+# -- 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/source/index.rst

@@ -0,0 +1,21 @@
+Home
+====
+
+Welcome the pymkv documentation!
+
+Modules
+-------
+
+.. toctree::
+    :maxdepth: 1
+
+    pymkv/MKVFile
+    pymkv/MKVTrack
+    pymkv/MKVAttachment
+
+Indices and tables
+------------------
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

docs/source/pymkv/MKVAttachment.rst

@@ -0,0 +1,8 @@
+MKVAttachment
+-------------
+
+.. automodule:: pymkv.MKVAttachment
+    :noindex:
+
+.. autoclass:: pymkv.MKVAttachment
+    :members:

docs/source/pymkv/MKVFile.rst

@@ -0,0 +1,8 @@
+MKVFile
+-------
+
+.. automodule:: pymkv.MKVFile
+    :noindex:
+
+.. autoclass:: pymkv.MKVFile
+    :members:

docs/source/pymkv/MKVTrack.rst

@@ -0,0 +1,8 @@
+MKVTrack
+--------
+
+.. automodule:: pymkv.MKVTrack
+    :noindex:
+
+.. autoclass:: pymkv.MKVTrack
+    :members:

requirements.txt

@@ -1,2 +1,3 @@
+# project dependencies
 bitmath
 iso-639

setup.py

@@ -8,10 +8,17 @@
 
 
 this_dir = abspath(dirname(__file__))
-with open(join(this_dir, 'README.rst'), encoding='utf-8') as file:
+with open(join(this_dir, 'README.md'), encoding='utf-8') as file:
     long_description = file.read()
 
-install_requires = [r.rstrip('\n') for r in open('requirements.txt').readlines()]
+setup_requires = [
+    'setuptools_scm'
+]
+
+install_requires = [
+    'bitmath',
+    'iso-639'
+]
 
 
 setup(
@@ -38,6 +45,6 @@
     keywords='wrapper',
     python_requires='>=3.6',
     use_scm_version=True,
-    setup_requires=['setuptools_scm'],
+    setup_requires=setup_requires,
     install_requires=install_requires,
 )