Skip to content

Commit 1474796

Browse files
onuralpszrKludex
andauthored
Use MkDocs (#108)
* chore: 🧹 python.gitignore added Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com> * docs: 🧹 removal of old documents,packages,requirements Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com> * docs: ✨ mkdocs-material packages added as doc-dep Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com> * docs: ✨ initial mkdocs pages and documentation added, old docs removed Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com> * docs: ✨ set sphinx doc style as default Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com> * docs: ✨ decoders,exceptions,helper-functions,main-class,parsers,support-classes added Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com> * fix: 🐞 package typo fix Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com> * docs: ✨ home page, quickstart sections added Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com> * ci: 👷 docs workflow added Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com> * Apply my opinion --------- Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com> Co-authored-by: Marcelo Trylesinski <marcelotryle@gmail.com>
1 parent c69d603 commit 1474796

31 files changed

+436
-2019
lines changed
File renamed without changes.

Diff for: .github/workflows/publish.yaml renamed to .github/workflows/publish.yml

+3-3
Original file line numberDiff line numberDiff line change
@@ -26,17 +26,17 @@ jobs:
2626
uses: actions/setup-python@v5
2727
with:
2828
python-version: "3.10"
29-
3029
- name: Install dependencies
3130
run: |
3231
python -m pip install --upgrade pip
3332
pip install build
34-
33+
pip install -e '.[docs]'
3534
- name: Build package
3635
run: python -m build
37-
3836
- name: Publish package
3937
uses: pypa/gh-action-pypi-publish@v1.8.11
4038
with:
4139
user: __token__
4240
password: ${{ secrets.PYPI_API_TOKEN }}
41+
- name: Publish docs
42+
run: mkdocs gh-deploy --force

Diff for: .gitignore

+162-23
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,6 @@
11
# Project-specific ignores.
2-
venv/
32
tmp/
43

5-
# Parts below taken from GitHub's gitignores repository: https://github.com/github/gitignore
6-
*.py[cod]
7-
8-
# C extensions
9-
*.so
10-
11-
# Packages
12-
*.egg
13-
*.egg-info
14-
MANIFEST
15-
dist
16-
/build
17-
eggs
18-
parts
19-
bin
20-
var
21-
sdist
22-
develop-eggs
23-
.installed.cfg
24-
lib
25-
lib64
26-
274
# Installer logs
285
pip-log.txt
296

@@ -59,3 +36,165 @@ $RECYCLE.BIN/
5936

6037
# OS X ignores
6138
.DS_Store
39+
40+
41+
# Byte-compiled / optimized / DLL files
42+
__pycache__/
43+
*.py[cod]
44+
*$py.class
45+
46+
# C extensions
47+
*.so
48+
49+
# Distribution / packaging
50+
.Python
51+
build/
52+
develop-eggs/
53+
dist/
54+
downloads/
55+
eggs/
56+
.eggs/
57+
lib/
58+
lib64/
59+
parts/
60+
sdist/
61+
var/
62+
wheels/
63+
share/python-wheels/
64+
*.egg-info/
65+
.installed.cfg
66+
*.egg
67+
MANIFEST
68+
69+
# PyInstaller
70+
# Usually these files are written by a python script from a template
71+
# before PyInstaller builds the exe, so as to inject date/other infos into it.
72+
*.manifest
73+
*.spec
74+
75+
# Installer logs
76+
pip-log.txt
77+
pip-delete-this-directory.txt
78+
79+
# Unit test / coverage reports
80+
htmlcov/
81+
.tox/
82+
.nox/
83+
.coverage
84+
.coverage.*
85+
.cache
86+
nosetests.xml
87+
coverage.xml
88+
*.cover
89+
*.py,cover
90+
.hypothesis/
91+
.pytest_cache/
92+
cover/
93+
94+
# Translations
95+
*.mo
96+
*.pot
97+
98+
# Django stuff:
99+
*.log
100+
local_settings.py
101+
db.sqlite3
102+
db.sqlite3-journal
103+
104+
# Flask stuff:
105+
instance/
106+
.webassets-cache
107+
108+
# Scrapy stuff:
109+
.scrapy
110+
111+
# Sphinx documentation
112+
docs/_build/
113+
114+
# PyBuilder
115+
.pybuilder/
116+
target/
117+
118+
# Jupyter Notebook
119+
.ipynb_checkpoints
120+
121+
# IPython
122+
profile_default/
123+
ipython_config.py
124+
125+
# pyenv
126+
# For a library or package, you might want to ignore these files since the code is
127+
# intended to run in multiple environments; otherwise, check them in:
128+
# .python-version
129+
130+
# pipenv
131+
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
132+
# However, in case of collaboration, if having platform-specific dependencies or dependencies
133+
# having no cross-platform support, pipenv may install dependencies that don't work, or not
134+
# install all needed dependencies.
135+
#Pipfile.lock
136+
137+
# poetry
138+
# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
139+
# This is especially recommended for binary packages to ensure reproducibility, and is more
140+
# commonly ignored for libraries.
141+
# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
142+
#poetry.lock
143+
144+
# pdm
145+
# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
146+
#pdm.lock
147+
# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
148+
# in version control.
149+
# https://pdm.fming.dev/#use-with-ide
150+
.pdm.toml
151+
152+
# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
153+
__pypackages__/
154+
155+
# Celery stuff
156+
celerybeat-schedule
157+
celerybeat.pid
158+
159+
# SageMath parsed files
160+
*.sage.py
161+
162+
# Environments
163+
.env
164+
.venv
165+
env/
166+
venv/
167+
ENV/
168+
env.bak/
169+
venv.bak/
170+
171+
# Spyder project settings
172+
.spyderproject
173+
.spyproject
174+
175+
# Rope project settings
176+
.ropeproject
177+
178+
# mkdocs documentation
179+
/site
180+
181+
# mypy
182+
.mypy_cache/
183+
.dmypy.json
184+
dmypy.json
185+
186+
# Pyre type checker
187+
.pyre/
188+
189+
# pytype static type analyzer
190+
.pytype/
191+
192+
# Cython debug symbols
193+
cython_debug/
194+
195+
# PyCharm
196+
# JetBrains specific template is maintained in a separate JetBrains.gitignore that can
197+
# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
198+
# and can be added to the global gitignore or merged into this file. For a more nuclear
199+
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
200+
#.idea/

Diff for: .gitmodules

-4
This file was deleted.

0 commit comments

Comments
 (0)