1
0
mirror of synced 2024-11-30 17:34:29 +01:00

Start adding docs

This commit is contained in:
Stepland 2022-08-30 19:10:21 +02:00
parent 26b3d46975
commit b0b7de676e
10 changed files with 122 additions and 3 deletions

View File

@ -7,10 +7,10 @@ jobs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Set up Python 3.8
- name: Set up Python 3.9
uses: actions/setup-python@v2
with:
python-version: 3.8
python-version: 3.9
- name: Install poetry
run: |
python -m pip install --upgrade pip

3
.gitignore vendored
View File

@ -4,4 +4,5 @@ __pycache__
.hypothesis
.pytest_cache
.mypy_cache
dist
dist
docs/build

20
docs/Makefile Normal file
View File

@ -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)

35
docs/make.bat Normal file
View File

@ -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
%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.https://www.sphinx-doc.org/
exit /b 1
)
if "%1" == "" goto help
%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
goto end
:help
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
:end
popd

3
docs/requirements.txt Normal file
View File

@ -0,0 +1,3 @@
Sphinx~=5.1
myst-parser~=0.18.0
furo==2022.6.21

1
docs/source/api.md Normal file
View File

@ -0,0 +1 @@
# API

28
docs/source/conf.py Normal file
View File

@ -0,0 +1,28 @@
# Configuration file for the Sphinx documentation builder.
#
# For the full list of built-in configuration values, see the documentation:
# https://www.sphinx-doc.org/en/master/usage/configuration.html
# -- Project information -----------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
project = 'jubeatools'
copyright = '2022, Stepland'
author = 'Stepland'
release = '1.4.0'
# -- General configuration ---------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
extensions = ["myst_parser"]
templates_path = ['_templates']
exclude_patterns = []
# -- Options for HTML output -------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
html_theme = 'furo'
html_static_path = ['_static']

View File

@ -0,0 +1,12 @@
# Converting Charts
Once jubeatools is [installed](installing.md), you can use its command-line interface.
The general usage is as follows :
```console
$ jubeatools (input) (output) -f (output format) (options)
```
## Input

14
docs/source/index.md Normal file
View File

@ -0,0 +1,14 @@
# jubeatools
A toolbox for jubeat file formats
```{toctree}
---
maxdepth: 2
---
installing
converting_charts
api
```

View File

@ -0,0 +1,5 @@
# Installation
```console
$ pip install jubeatools
```