Skip to content

Commit c2d8245

Browse files
yuta0306yuta0306
committed
add docs
1 parent b3a6311 commit c2d8245

24 files changed

+1363
-204
lines changed

‎.github/workflows/gh-pages.yml

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
name: gh-pages
2+
on:
3+
push:
4+
tags:
5+
- "v*.*.*"
6+
workflow_dispatch:
7+
8+
jobs:
9+
release:
10+
name: Build
11+
runs-on: ubuntu-latest
12+
if: "!contains(github.event.head_commit.message, 'auto rebuilding site')"
13+
environment:
14+
name: github-pages
15+
steps:
16+
- name: Checkout
17+
uses: actions/checkout@v2
18+
- name: Set up Python
19+
uses: actions/setup-python@v4
20+
with:
21+
python-version: "3.10"
22+
- name: Install Poetry
23+
run: |
24+
curl -sSL https://install.python-poetry.org | python3 -
25+
- name: Add path for Poetry
26+
run: echo "$HOME/.local/bin" >> $GITHUB_PATH
27+
- name: Add Poetry Plugin
28+
# poetry plugin add poetry-dynamic-versioning
29+
run: |
30+
poetry self add "poetry-dynamic-versioning[plugin]"
31+
- name: Build
32+
run: |
33+
make html
34+
- name: Deploy
35+
uses: peaceiris/actions-gh-pages@v3
36+
with:
37+
github_token: ${{ secrets.GITHUB_TOKEN }}
38+
publish_dir: ./docs/_build

‎.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -158,3 +158,5 @@ cython_debug/
158158
# and can be added to the global gitignore or merged into this file. For a more nuclear
159159
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
160160
#.idea/
161+
162+
.vscode/

‎docs/Makefile

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Minimal makefile for Sphinx documentation
2+
#
3+
4+
# You can set these variables from the command line, and also
5+
# from the environment for the first two.
6+
SPHINXOPTS ?=
7+
SPHINXBUILD ?= sphinx-build
8+
SOURCEDIR = .
9+
BUILDDIR = _build
10+
11+
# Put it first so that "make" without argument is like "make help".
12+
help:
13+
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
14+
15+
.PHONY: help Makefile
16+
17+
# Catch-all target: route all unknown targets to Sphinx using the new
18+
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
19+
%: Makefile
20+
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

‎docs/conf.py

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
# Configuration file for the Sphinx documentation builder.
2+
#
3+
# This file only contains a selection of the most common options. For a full
4+
# list see the documentation:
5+
# https://www.sphinx-doc.org/en/master/usage/configuration.html
6+
7+
# -- Path setup --------------------------------------------------------------
8+
9+
# If extensions (or modules to document with autodoc) are in another directory,
10+
# add these directories to sys.path here. If the directory is relative to the
11+
# documentation root, use os.path.abspath to make it absolute, like shown here.
12+
#
13+
import os
14+
import sys
15+
16+
sys.path.insert(0, os.path.abspath("../"))
17+
18+
19+
# -- Project information -----------------------------------------------------
20+
21+
project = "dslclib"
22+
copyright = "2023, Yuta SASAKI"
23+
author = "Yuta SASAKI"
24+
25+
26+
# -- General configuration ---------------------------------------------------
27+
28+
# Add any Sphinx extension module names here, as strings. They can be
29+
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
30+
# ones.
31+
extensions = [
32+
"sphinx.ext.autodoc",
33+
"sphinx.ext.napoleon",
34+
"sphinx.ext.githubpages",
35+
]
36+
37+
# Add any paths that contain templates here, relative to this directory.
38+
templates_path = ["_templates"]
39+
40+
# The language for content autogenerated by Sphinx. Refer to documentation
41+
# for a list of supported languages.
42+
#
43+
# This is also used if you do content translation via gettext catalogs.
44+
# Usually you set "language" from the command line for these cases.
45+
language = "ja"
46+
47+
# List of patterns, relative to source directory, that match files and
48+
# directories to ignore when looking for source files.
49+
# This pattern also affects html_static_path and html_extra_path.
50+
exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
51+
52+
53+
# -- Options for HTML output -------------------------------------------------
54+
55+
# The theme to use for HTML and HTML Help pages. See the documentation for
56+
# a list of builtin themes.
57+
#
58+
html_theme = "furo"
59+
60+
# Add any paths that contain custom static files (such as style sheets) here,
61+
# relative to this directory. They are copied after the builtin static files,
62+
# so a file named "default.css" will overwrite the builtin "default.css".
63+
html_static_path = ["_static"]
64+
65+
autodoc_default_options = {
66+
"members": True,
67+
"private-members": True,
68+
"undoc-members": False,
69+
# "special-members": "__init__, __new__",
70+
}
71+
72+
autoclass_content = "both"
73+
autodoc_typehints_format = "fully-qualified"

‎docs/dslclib.rst

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
dslclib package
2+
===============
3+
4+
Subpackages
5+
-----------
6+
7+
.. toctree::
8+
:maxdepth: 4
9+
10+
dslclib.src
11+
12+
Module contents
13+
---------------
14+
15+
.. automodule:: dslclib
16+
:members:
17+
:undoc-members:
18+
:show-inheritance:

‎docs/dslclib.src.base.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
dslclib.src.base module
2+
=======================
3+
4+
.. automodule:: dslclib.src.base
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

‎docs/dslclib.src.body_controller.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
dslclib.src.body\_controller module
2+
===================================
3+
4+
.. automodule:: dslclib.src.body_controller
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

‎docs/dslclib.src.expression_controller.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
dslclib.src.expression\_controller module
2+
=========================================
3+
4+
.. automodule:: dslclib.src.expression_controller
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

‎docs/dslclib.src.face_recognition.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
dslclib.src.face\_recognition module
2+
====================================
3+
4+
.. automodule:: dslclib.src.face_recognition
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

‎docs/dslclib.src.rst

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
dslclib.src package
2+
===================
3+
4+
Submodules
5+
----------
6+
7+
.. toctree::
8+
:maxdepth: 4
9+
10+
dslclib.src.base
11+
dslclib.src.body_controller
12+
dslclib.src.expression_controller
13+
dslclib.src.face_recognition
14+
dslclib.src.speech_recognition
15+
dslclib.src.tts
16+
17+
Module contents
18+
---------------
19+
20+
.. automodule:: dslclib.src
21+
:members:
22+
:undoc-members:
23+
:show-inheritance:

0 commit comments

Comments
 (0)