public/setclass
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

Update README with docs

Browse source
This commit is contained in:
Jonathan Harker 2024-10-15 14:55:15 +13:00
parent a85898b416
commit 8bb811cf1c
3 changed files with 9 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
README.md
View file

@ -25,17 +25,20 @@ In Python:
from setclass import SetClass from setclass import SetClass
sc = SetClass(0, 3, 5, 6, 7, 10, 11) # Forte 7-20; pitch classes as integers 0-11 sc = SetClass(0, 3, 5, 6, 7, 10, 11) # Forte 7-20; pitch classes as integers 0-11
sc.versions sc.versions
sc.brightest_form sc.rahn_normal_form
sc.darkest_form sc.forte_name
sc.duodecimal_notation # SetClass[0,3,5,6,7,T,E] 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 ## TODO
- Documentation (Sphinx) - <s>Documentation (Sphinx)</s>
- Interoperate with music21 objects - Interoperate with music21 objects
- Generate MIDI files - Generate MIDI files
- Generate LilyPond files for set pitches - Generate LilyPond files for set pitches

3
docs/Makefile
View file

@ -3,8 +3,9 @@
# You can set these variables from the command line, and also # You can set these variables from the command line, and also
# from the environment for the first two. # from the environment for the first two.
PROJROOT := $(abspath $(MAKEFILE_LIST)/../..)
SPHINXOPTS ?= SPHINXOPTS ?=
SPHINXBUILD ?= sphinx-build SPHINXBUILD ?= PYTHONPATH="$(PROJROOT)" sphinx-build
SOURCEDIR = source SOURCEDIR = source
BUILDDIR = build BUILDDIR = build

2
docs/source/conf.py
View file

@ -62,9 +62,7 @@ source_suffix = {
# -- Options for HTML output ------------------------------------------------- # -- Options for HTML output -------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#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 = 'sphinx_rtd_theme'
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
html_theme_options = { html_theme_options = {
'display_version': False,
'navigation_depth': 2, 'navigation_depth': 2,
'prev_next_buttons_location': 'None' 'prev_next_buttons_location': 'None'
} }