diff --git a/README.md b/README.md index 4ef266f..43fa602 100644 --- a/README.md +++ b/README.md @@ -25,17 +25,20 @@ In Python: from setclass import SetClass sc = SetClass(0, 3, 5, 6, 7, 10, 11) # Forte 7-20; pitch classes as integers 0-11 sc.versions -sc.brightest_form -sc.darkest_form +sc.rahn_normal_form +sc.forte_name sc.duodecimal_notation # SetClass[0,3,5,6,7,T,E] ``` -Proper library documentation to come soon with Sphinx. +Documentation is generated from the doc comments with Sphinx, and in the meantime is available [here](https://git.jon.geek.nz/docs/public/setclass/setclass.html): +``` +make -C docs html +``` ## TODO -- Documentation (Sphinx) +- Documentation (Sphinx) - Interoperate with music21 objects - Generate MIDI files - Generate LilyPond files for set pitches diff --git a/docs/Makefile b/docs/Makefile index d0c3cbf..0cda907 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -3,8 +3,9 @@ # You can set these variables from the command line, and also # from the environment for the first two. +PROJROOT := $(abspath $(MAKEFILE_LIST)/../..) SPHINXOPTS ?= -SPHINXBUILD ?= sphinx-build +SPHINXBUILD ?= PYTHONPATH="$(PROJROOT)" sphinx-build SOURCEDIR = source BUILDDIR = build diff --git a/docs/source/conf.py b/docs/source/conf.py index b4ff5b5..270dde4 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -62,9 +62,7 @@ source_suffix = { # -- Options for HTML output ------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output html_theme = 'sphinx_rtd_theme' -html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] html_theme_options = { - 'display_version': False, 'navigation_depth': 2, 'prev_next_buttons_location': 'None' }