Skip to content

Commit 9b01ee1

Browse files
cocolatococolato
authored
Merge pull request #29 from cocolato/dev
Merge dev
2 parents 15b561b + 79ca9ef commit 9b01ee1

15 files changed

+420
-3
lines changed

‎.gitignore‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,3 +11,6 @@ test.py
1111

1212
dist/
1313
.pdm-python
14+
15+
# Sphinx documentation
16+
docs/build/

‎.readthedocs.yaml‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Required
2+
version: 2
3+
4+
# Set the OS, Python version and other tools you might need
5+
build:
6+
os: ubuntu-22.04
7+
tools:
8+
python: "3.11"
9+
10+
11+
python:
12+
install:
13+
- requirements: docs/requirements.txt
14+
sphinx:
15+
configuration: docs/source/conf.py

‎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 = source
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/make.bat‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
@ECHO OFF
2+
3+
pushd %~dp0
4+
5+
REM Command file for Sphinx documentation
6+
7+
if "%SPHINXBUILD%" == "" (
8+
set SPHINXBUILD=sphinx-build
9+
)
10+
set SOURCEDIR=source
11+
set BUILDDIR=build
12+
13+
if "%1" == "" goto help
14+
15+
%SPHINXBUILD% >NUL 2>NUL
16+
if errorlevel 9009 (
17+
echo.
18+
echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
19+
echo.installed, then set the SPHINXBUILD environment variable to point
20+
echo.to the full path of the 'sphinx-build' executable. Alternatively you
21+
echo.may add the Sphinx directory to PATH.
22+
echo.
23+
echo.If you don't have Sphinx installed, grab it from
24+
echo.https://www.sphinx-doc.org/
25+
exit /b 1
26+
)
27+
28+
%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
29+
goto end
30+
31+
:help
32+
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
33+
34+
:end
35+
popd

‎docs/requirements.txt‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
# This file is @generated by PDM.
2+
# Please do not edit it manually.
3+
4+
alabaster==0.7.13
5+
babel==2.14.0
6+
certifi==2024.2.2
7+
charset-normalizer==3.3.2
8+
colorama==0.4.6; sys_platform == "win32"
9+
dill==0.3.7
10+
docutils==0.17.1
11+
exceptiongroup==1.2.0; python_version < "3.11"
12+
flake8==5.0.4
13+
idna==3.6
14+
imagesize==1.4.1
15+
importlib-metadata==4.2.0; python_version < "3.8"
16+
iniconfig==2.0.0
17+
jinja2==3.1.3
18+
markupsafe==2.1.5
19+
mccabe==0.7.0
20+
packaging==23.2
21+
pluggy==1.2.0
22+
pycodestyle==2.9.1
23+
pyflakes==2.5.0
24+
pygments==2.17.2
25+
pytest==7.4.4
26+
pytest-order==1.2.0
27+
pytz==2024.1; python_version < "3.9"
28+
requests==2.31.0
29+
setuptools==68.0.0
30+
snowballstemmer==2.2.0
31+
sphinx==4.3.2
32+
sphinx-copybutton==0.5.2
33+
sphinx-rtd-theme==1.3.0
34+
sphinx-tabs==3.4.5
35+
sphinxcontrib-applehelp==1.0.2
36+
sphinxcontrib-devhelp==1.0.2
37+
sphinxcontrib-htmlhelp==2.0.0
38+
sphinxcontrib-jquery==4.1
39+
sphinxcontrib-jsmath==1.0.1
40+
sphinxcontrib-qthelp==1.0.3
41+
sphinxcontrib-serializinghtml==1.1.5
42+
tomli==2.0.1; python_version < "3.11"
43+
typing-extensions==4.7.1; python_version < "3.8"
44+
urllib3==2.0.7
45+
zipp==3.15.0; python_version < "3.8"

‎docs/source/_static/favicon.png‎

201 Bytes
Loading

‎docs/source/_static/header_photo_1.png‎

6.48 KB
Loading

‎docs/source/_static/logo.png‎

4.62 KB
Loading

‎docs/source/_static/rpdb.png‎

11.7 KB
Loading

‎docs/source/conf.py‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# Configuration file for the Sphinx documentation builder.
2+
#
3+
# For the full list of built-in configuration values, see the documentation:
4+
# https://www.sphinx-doc.org/en/master/usage/configuration.html
5+
6+
# -- Project information -----------------------------------------------------
7+
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
8+
9+
project = 'pydumpling'
10+
copyright = '2024, cocolato'
11+
author = 'cocolato'
12+
release = '0.1.4'
13+
14+
# -- General configuration ---------------------------------------------------
15+
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
16+
html_context = {
17+
"display_github": True, # Integrate GitHub
18+
"github_user": "cocolato", # Username
19+
"github_repo": "pydumpling", # Repo name
20+
"github_version": "main", # Version
21+
"conf_py_path": "/source/", # Path in the checkout to the docs root
22+
}
23+
24+
extensions = [
25+
"sphinx_rtd_theme",
26+
"sphinx_tabs.tabs",
27+
"sphinx_copybutton"
28+
]
29+
30+
templates_path = ['_templates']
31+
exclude_patterns = []
32+
33+
34+
html_theme = "sphinx_rtd_theme"
35+
36+
html_static_path = ['_static']
37+
html_logo = "_static/logo.png"
38+
html_favicon = "_static/favicon.png"
39+
html_title = "Pydumpling Documentation"
40+
html_show_sourcelink = False

0 commit comments

Comments
 (0)