Skip to content

Commit 97244c5

Browse files
keitaaykeitaay
committed
Initial commit to follow up on executablebooks/sphinx-design/issues/217
Signed-off-by: Keita Yokoyama <kyokoyama777@gmail.com>
0 parents  commit 97244c5

8 files changed

Lines changed: 519 additions & 0 deletions

File tree

‎.gitignore‎

Lines changed: 204 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,204 @@
1+
.git
2+
3+
# Local copies of other repos
4+
docs/source/_code/rosetta-*
5+
6+
# Compiled source
7+
*.com
8+
*.class
9+
*.dll
10+
*.exe
11+
*.o
12+
*.so
13+
14+
# Packages
15+
*.7z
16+
*.dmg
17+
*.gz
18+
*.iso
19+
*.jar
20+
*.rar
21+
*.tar
22+
*.zip
23+
24+
# Logs and databases
25+
*.log
26+
*.sql
27+
*.sqlite
28+
29+
# OS generated files
30+
.DS_Store
31+
.DS_Store?
32+
._*
33+
.Spotlight-V100
34+
.Trashes
35+
ehthumbs.db
36+
Thumbs.db
37+
38+
# IPython: Jupyter
39+
.ipynb_checkpoints
40+
*/.ipynb_checkpoints/*
41+
42+
# IPython
43+
profile_default/
44+
ipython_config.py
45+
46+
# IPython: Remove previous ipynb_checkpoints
47+
# git rm -r .ipynb_checkpoints/
48+
49+
# Python: Byte-compiled / optimized / DLL files
50+
__pycache__/
51+
*.py[cod]
52+
*$py.class
53+
54+
# Python: C extensions
55+
*.so
56+
57+
# Python: Distribution / packaging
58+
.Python
59+
build/
60+
develop-eggs/
61+
dist/
62+
downloads/
63+
eggs/
64+
.eggs/
65+
lib/
66+
lib64/
67+
parts/
68+
sdist/
69+
var/
70+
wheels/
71+
share/python-wheels/
72+
*.egg-info/
73+
.installed.cfg
74+
*.egg
75+
MANIFEST
76+
77+
# Python: PyInstaller and installer logs
78+
*.manifest
79+
*.spec
80+
pip-log.txt
81+
pip-delete-this-directory.txt
82+
83+
# Python: unit tests and coverage reports
84+
htmlcov/
85+
.tox/
86+
.nox/
87+
.coverage
88+
.coverage.*
89+
.cache
90+
nosetests.xml
91+
coverage.xml
92+
*.cover
93+
*.py,cover
94+
.hypothesis/
95+
.pytest_cache/
96+
cover/
97+
98+
# Python: translations
99+
*.mo
100+
*.pot
101+
102+
# Python: Sphinx documentation
103+
docs/_build/
104+
105+
# Python: PyBuilder
106+
.pybuilder/
107+
target/
108+
109+
# Python: pyenv
110+
# .python-version
111+
112+
# Python: pipenv
113+
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
114+
# However, in case of collaboration, if having platform-specific dependencies or dependencies
115+
# having no cross-platform support, pipenv may install dependencies that don't work, or not
116+
# install all needed dependencies.
117+
#Pipfile.lock
118+
119+
# Python: PEP 582 - used by e.g. github.com/David-OConnor/pyflow
120+
__pypackages__/
121+
122+
# Python: Celery
123+
celerybeat-schedule
124+
celerybeat.pid
125+
126+
# Python: SageMath parsed files
127+
*.sage.py
128+
129+
# Python: environments
130+
.env
131+
.venv
132+
env/
133+
venv/
134+
ENV/
135+
env.bak/
136+
venv.bak/
137+
138+
# Python: Spyder project settings
139+
.spyderproject
140+
.spyproject
141+
142+
# Python: Rope project settings
143+
.ropeproject
144+
145+
# mkdocs documentation
146+
/site
147+
148+
# Python: mypy
149+
.mypy_cache/
150+
.dmypy.json
151+
dmypy.json
152+
153+
# Python: Pyre type checker
154+
.pyre/
155+
156+
# Python: pytype static type analyzer
157+
.pytype/
158+
159+
# Python: Cython debug symbols
160+
cython_debug/
161+
162+
# Node.js: Logs
163+
logs
164+
*.log
165+
npm-debug.log*
166+
yarn-debug.log*
167+
yarn-error.log*
168+
lerna-debug.log*
169+
.pnpm-debug.log*
170+
171+
# Node.js: Diagnostic reports (https://nodejs.org/api/report.html)
172+
report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
173+
174+
# Node.js: Runtime data
175+
pids
176+
*.pid
177+
*.seed
178+
*.pid.lock
179+
180+
# Node.js: Compiled binary addons (https://nodejs.org/api/addons.html)
181+
build/Release
182+
183+
# Node.js: Dependency directories
184+
node_modules/
185+
jspm_packages/
186+
187+
# Node.js: Optional npm cache directory
188+
.npm
189+
190+
# Node.js: Optional eslint cache
191+
.eslintcache
192+
193+
# Node.js: Optional REPL history
194+
.node_repl_history
195+
196+
# Node.js: Output of 'npm pack'
197+
*.tgz
198+
199+
# Node.js: dotenv environment variable files
200+
.env
201+
.env.development.local
202+
.env.test.local
203+
.env.production.local
204+
.env.local

‎.prettierignore‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Ignore artifacts
2+
docs/_build
3+
4+
# Ignore all HTML files
5+
**/*.html
6+
7+
# Ignore select source files that violate Prettier's formatting conventions by necessity
8+
docs/source/index.md
9+
docs/source/contribute.md
10+
docs/source/glossary.md
11+
docs/source/_template/md/*.md

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

‎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+
%SPHINXBUILD% >NUL 2>NUL
14+
if errorlevel 9009 (
15+
echo.
16+
echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
17+
echo.installed, then set the SPHINXBUILD environment variable to point
18+
echo.to the full path of the 'sphinx-build' executable. Alternatively you
19+
echo.may add the Sphinx directory to PATH.
20+
echo.
21+
echo.If you don't have Sphinx installed, grab it from
22+
echo.https://www.sphinx-doc.org/
23+
exit /b 1
24+
)
25+
26+
if "%1" == "" goto help
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

‎requirements.txt‎

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
accessible-pygments==0.0.5
2+
alabaster==1.0.0
3+
anyio==4.7.0
4+
babel==2.16.0
5+
beautifulsoup4==4.12.3
6+
Brotli==1.1.0
7+
certifi==2024.12.14
8+
cffi==1.17.1
9+
charset-normalizer==3.4.0
10+
click==8.1.7
11+
colorama==0.4.6
12+
contourpy==1.3.1
13+
cycler==0.12.1
14+
docutils==0.21.2
15+
exceptiongroup==1.2.2
16+
fonttools==4.55.3
17+
h11==0.14.0
18+
h2==4.1.0
19+
hpack==4.0.0
20+
hyperframe==6.0.1
21+
idna==3.10
22+
imagesize==1.4.1
23+
importlib_metadata==8.5.0
24+
Jinja2==3.1.4
25+
kiwisolver==1.4.7
26+
latexcodec==2.0.1
27+
markdown-it-py==3.0.0
28+
MarkupSafe==3.0.2
29+
matplotlib==3.10.0
30+
mdit-py-plugins==0.4.2
31+
mdurl==0.1.2
32+
munkres==1.1.4
33+
myst-parser==4.0.0
34+
numpy==2.2.0
35+
packaging==24.2
36+
pillow==11.0.0
37+
pip==24.3.1
38+
pybtex==0.24.0
39+
pybtex-docutils==1.0.3
40+
pycparser==2.22
41+
pydata-sphinx-theme==0.15.4
42+
Pygments==2.18.0
43+
pyparsing==3.2.0
44+
PySocks==1.7.1
45+
python-dateutil==2.9.0.post0
46+
pytz==2024.2
47+
PyYAML==6.0.2
48+
requests==2.32.3
49+
setuptools==75.6.0
50+
six==1.17.0
51+
sniffio==1.3.1
52+
snowballstemmer==2.2.0
53+
soupsieve==2.5
54+
Sphinx==8.1.3
55+
sphinx-autobuild==2024.10.3
56+
sphinx-book-theme==1.1.3
57+
sphinx-copybutton==0.5.2
58+
sphinx_design==0.6.1
59+
sphinx-favicon==1.0.1
60+
sphinx-prompt==1.4.0
61+
sphinxcontrib-applehelp==2.0.0
62+
sphinxcontrib-bibtex==2.6.3
63+
sphinxcontrib-devhelp==2.0.0
64+
sphinxcontrib-htmlhelp==2.1.0
65+
sphinxcontrib-jsmath==1.0.1
66+
sphinxcontrib-matlabdomain==0.22.1
67+
sphinxcontrib-qthelp==2.0.0
68+
sphinxcontrib-serializinghtml==1.1.10
69+
sphinxext-opengraph==0.9.1
70+
starlette==0.42.0
71+
tomli==2.2.1
72+
typing_extensions==4.12.2
73+
urllib3==2.2.3
74+
uvicorn==0.34.0
75+
watchfiles==1.0.3
76+
websockets==14.1
77+
zipp==3.21.0
78+
zstandard==0.23.0

0 commit comments

Comments
 (0)
⚡