Finish first version of the docs

.readthedocs.yaml

@@ -0,0 +1,17 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+version: 2
+
+build:
+  os: ubuntu-20.04
+  tools:
+    python: "3.9"
+
+sphinx:
+   configuration: docs/source/conf.py
+
+python:
+   install:
+   - requirements: docs/requirements.txt

docs/source/_static/css/custom.css

@@ -9,4 +9,9 @@
 
 .japanese-monospaced pre {
     font-family: var(--font-mono-jp);
+}
+
+/* Hide the ugly toctree captions on the main page */
+section#jubeatools div.toctree-wrapper span.caption-text {
+    display: none;
 }

docs/source/cli.md

@@ -1,2 +1,80 @@
 # Command-line Interface
 
+## Usage
+
+```console
+$ jubeatools [OPTIONS] SRC DST
+```
+
+## Positional Arguments
+
+`SRC`
+: *source*, path to the input chart file or chart folder
+
+`DST`
+: *destination*,  output path template to use for the output file or set of
+  files. See [](<library/writing chart files.md#the-output-path-template>) for more
+  info
+
+## Options
+
+### Input
+
+`--input-format=FORMAT`
+: Force jubeatools to read the input file / folder as the given format. If this
+  option is not used jubeatools will try to guess the format using
+  [`guess_format()`](guess_format).
+
+  Possible values : `eve`, `jbsq`, `malody`, `memon:legacy`, `memon:v0.1.0`,
+  `memon:v0.2.0`, `memon:v0.3.0`, `memon:v1.0.0`, `mono-column`, `memo`,
+  `memo1`, `memo2`
+
+`--beat-snap=NUMBER`
+: Snap all notes and bpm changes to the nearest {math}`\frac{1}{\texttt{NUMBER}}` beat
+
+  Applies to the following formats : `eve`, `jbsq`
+
+  Possibles values : Integers >= 1
+
+`--merge`
+: If called on a folder, merge all the chart files found inside with a
+  "permissive" strategy.
+
+  Applies to the following formats: `memon:legacy`, `memon:v0.1.0`,
+  `memon:v0.2.0`, `memon:v0.3.0`, `memon:v1.0.0`
+
+### Output
+
+`-f, --format=FORMAT`
+: Output file format
+
+  **required**
+
+  Possible values : `eve`, `jbsq`, `malody`, `memon:legacy`, `memon:v0.1.0`,
+  `memon:v0.2.0`, `memon:v0.3.0`, `memon:v1.0.0`, `mono-column`, `memo`,
+  `memo1`, `memo2`
+
+`--circlefree`
+: Add `#circlefree=1` to the file header when converting to a format from the
+  jubeat analyser family.
+  
+  This means long note ends will be written down with non-circled numbers, like
+  in this example :
+
+  ```{code}
+  :class: japanese-monospaced
+  □□□□　|－－①－|
+  ①――＜　|－－②－|
+  □□□□　|－－－－|
+  □□□□　|－－－－|
+  
+  □□□□
+  ２□□□
+  □□□□
+  □□□□
+  ```
+
+### Other
+
+`--help`
+: Show the help text and exit

docs/source/conf.py

@@ -46,10 +46,12 @@ html_css_files = [
     'css/custom.css',
 ]
 
+myst_heading_anchors = 2
+
 myst_enable_extensions = [
     # "amsmath",
     "colon_fence",
-    # "deflist",
+    "deflist",
     # "dollarmath",
     "fieldlist",
     # "html_admonition",

docs/source/index.md

@@ -2,18 +2,22 @@
 
 A toolbox for jubeat file formats
 
+## For Charters
+
+If you just want to use jubeatools to convert a chart, read these pages :
+
 ```{toctree}
 :caption: For Charters
 :maxdepth: 1
-:hidden:
 how to install jubeatools
 how to convert charts
 ```
 
+## For Developers
+
 ```{toctree}
 :caption: For Developers
 :maxdepth: 1
-:hidden:
 library/index
 cli
 api/index

docs/source/library/writing chart files.md

@@ -58,7 +58,8 @@ in [](<../api/loaders and dumpers.md>).
 Dumpers all take in an output path template. If it doesn't point to an existing
 *folder*, the path is used as a [format string](https://docs.python.org/3/library/string.html#format-string-syntax).
 
-The following parameters are available, they are all passed as `str` :
+The following parameters are available for the format string, they are all
+passed as `str` objects :
 
 | name                | description                                        |
 |---------------------|----------------------------------------------------|