Removed Sphinx documentation system
This commit is contained in:
parent
fd63beab86
commit
26521be98d
20
doc/Makefile
20
doc/Makefile
|
|
@ -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 = 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)
|
||||
|
|
@ -1,5 +0,0 @@
|
|||
Sphinx==4.5.0
|
||||
breathe==4.33.1
|
||||
exhale==0.3.1
|
||||
recommonmark==0.7.1
|
||||
sphinx-rtd-theme==1.0.0
|
||||
|
|
@ -1,54 +0,0 @@
|
|||
program = { expression, ws*, ";", { ws*, ";" }, ws* } ;
|
||||
block = "[", program, "]" ;
|
||||
|
||||
(* At interpreter runtime it is determined which symbols pass as operators, and which not *)
|
||||
expression = value, ws*, operator, ws*, expression
|
||||
| operator, ws*, value
|
||||
| value ;
|
||||
|
||||
value = note
|
||||
| chord
|
||||
| symbol
|
||||
| block
|
||||
| number
|
||||
| ( "(", expression, ")" ) ;
|
||||
|
||||
symbol = ( valid-symbol-start-characters, { valid-symbol-characters } ) - note - chord;
|
||||
valid-symbol-start-characters = uniletter | "_" | "@" | "$" | "#" ;
|
||||
valid-symbol-characters = valid-symbol-start-characters | unidigit | "-" ;
|
||||
|
||||
operator = operator-symbols, { operator-symbols } ;
|
||||
operator-symbols = "+" | "-" | "*" | "/" | "%" | "!"
|
||||
| "<" | ">" | "v" | "^" | "=" | ":" ;
|
||||
|
||||
(********************************* Literały liczbowe *********************************)
|
||||
number = floating-point | fraction ;
|
||||
|
||||
(* Dopuszcza następujące zapisy: 1/2, *)
|
||||
fraction = digits+, ws*, "/", ws*, digits+ ;
|
||||
|
||||
(* Dopuszcza następujące zapisy: -123.456, 123.456, .456; Notacja naukowa nie jest wspierana *)
|
||||
floating-point = ( ["-"], digits+, [ ".", digits+ ] ) | ( ".", digits+ );
|
||||
|
||||
|
||||
(********************************* Literały muzyczne *********************************)
|
||||
(* DSL do definiowania muzycznych wartości. Brakuje notacji dla akordów, przewrotów itd *)
|
||||
note = note-letter, ["#"], [ws*, octave] ;
|
||||
note-letter = "c" | "C" | "d" | "D" | "e" | "E" | "f" | "F" | "g" | "G" | "a" | "A" | "h" | "H" | "b" | "B" ;
|
||||
octave = "1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" ;
|
||||
|
||||
chord = note-letter, ["#"], [ ("1" | "2" | "5" | "7" ), [ "," | "'" ] ];
|
||||
|
||||
(********************************* Definicje pomocnicze *********************************)
|
||||
|
||||
(* Unicode helpers, based on Go's compiler source code *)
|
||||
uniletter = ? all characters that are considered letters in unicode ?;
|
||||
unidigit = ? all characters that are considered digits in unicode ?;
|
||||
|
||||
digits+ = digit, { digits } ;
|
||||
digit = "0" | "1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9" ;
|
||||
|
||||
(* Whitespace helpers *)
|
||||
ws* = { ws } ;
|
||||
ws+ = ws, { ws } ;
|
||||
ws = ? all characters that are considered ascii whitespace ? ;
|
||||
|
|
@ -1,55 +0,0 @@
|
|||
# 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
|
||||
|
||||
# -- Project information -----------------------------------------------------
|
||||
|
||||
project = 'Musique'
|
||||
copyright = '2022, Robert Bendun'
|
||||
author = 'Robert Bendun'
|
||||
|
||||
# -- General configuration ---------------------------------------------------
|
||||
|
||||
extensions = [
|
||||
"sphinx_rtd_theme",
|
||||
"breathe",
|
||||
"recommonmark",
|
||||
"exhale"
|
||||
]
|
||||
|
||||
breathe_projects = {
|
||||
"musique": "../build/doxygen/xml"
|
||||
}
|
||||
|
||||
breathe_default_project = "musique"
|
||||
|
||||
exhale_args = {
|
||||
"containmentFolder": "./api",
|
||||
"rootFileName": "musique-root.rst",
|
||||
"createTreeView": True,
|
||||
"doxygenStripFromPath": ".."
|
||||
}
|
||||
|
||||
primary_domain = "cpp"
|
||||
highlight_language = "cpp"
|
||||
|
||||
# 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 = []
|
||||
|
||||
|
||||
# -- 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']
|
||||
|
|
@ -1,22 +0,0 @@
|
|||
.. Musique documentation master file, created by
|
||||
sphinx-quickstart on Sun May 8 17:37:28 2022.
|
||||
You can adapt this file completely to your liking, but it should at least
|
||||
contain the root `toctree` directive.
|
||||
|
||||
Welcome to Musique's documentation!
|
||||
===================================
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
:caption: Contents:
|
||||
|
||||
api/musique-root
|
||||
|
||||
|
||||
|
||||
Indices and tables
|
||||
==================
|
||||
|
||||
* :ref:`genindex`
|
||||
* :ref:`modindex`
|
||||
* :ref:`search`
|
||||
Loading…
Reference in New Issue