From efb5ab1a5bacb0a9d69a0e7b7d665ca83446ab26 Mon Sep 17 00:00:00 2001 From: Yusur Princeps Date: Fri, 10 Oct 2025 19:52:48 +0200 Subject: [PATCH] add docs --- .gitignore | 3 ++ .readthedocs.yaml | 10 ++++++ docs/Makefile | 20 ++++++++++++ docs/api.rst | 41 ++++++++++++++++++++++++ docs/conf.py | 30 +++++++++++++++++ docs/generated/suou.asgi.rst | 6 ++++ docs/generated/suou.bits.rst | 17 ++++++++++ docs/generated/suou.calendar.rst | 16 +++++++++ docs/generated/suou.classtools.rst | 16 +++++++++ docs/generated/suou.codecs.rst | 36 +++++++++++++++++++++ docs/generated/suou.collections.rst | 12 +++++++ docs/generated/suou.color.rst | 13 ++++++++ docs/generated/suou.configparse.rst | 18 +++++++++++ docs/generated/suou.dei.rst | 24 ++++++++++++++ docs/generated/suou.dorks.rst | 6 ++++ docs/generated/suou.exceptions.rst | 24 ++++++++++++++ docs/generated/suou.flask.rst | 16 +++++++++ docs/generated/suou.flask_restx.rst | 18 +++++++++++ docs/generated/suou.flask_sqlalchemy.rst | 18 +++++++++++ docs/generated/suou.functools.rst | 18 +++++++++++ docs/generated/suou.http.rst | 12 +++++++ docs/generated/suou.i18n.rst | 16 +++++++++ docs/generated/suou.iding.rst | 22 +++++++++++++ docs/generated/suou.itertools.rst | 23 +++++++++++++ docs/generated/suou.legal.rst | 6 ++++ docs/generated/suou.lex.rst | 6 ++++ docs/generated/suou.luck.rst | 19 +++++++++++ docs/generated/suou.markdown.rst | 16 +++++++++ docs/generated/suou.migrate.rst | 14 ++++++++ docs/generated/suou.quart.rst | 14 ++++++++ docs/generated/suou.redact.rst | 12 +++++++ docs/generated/suou.rst | 6 ++++ docs/generated/suou.sass.rst | 12 +++++++ docs/generated/suou.signing.rst | 13 ++++++++ docs/generated/suou.snowflake.rst | 13 ++++++++ docs/generated/suou.sqlalchemy.rst | 20 ++++++++++++ docs/generated/suou.strtools.rst | 12 +++++++ docs/generated/suou.terminal.rst | 12 +++++++ docs/generated/suou.validators.rst | 15 +++++++++ docs/generated/suou.waiter.rst | 19 +++++++++++ docs/index.rst | 18 +++++++++++ docs/make.bat | 35 ++++++++++++++++++++ src/suou/__init__.py | 2 +- 43 files changed, 698 insertions(+), 1 deletion(-) create mode 100644 .readthedocs.yaml create mode 100644 docs/Makefile create mode 100644 docs/api.rst create mode 100644 docs/conf.py create mode 100644 docs/generated/suou.asgi.rst create mode 100644 docs/generated/suou.bits.rst create mode 100644 docs/generated/suou.calendar.rst create mode 100644 docs/generated/suou.classtools.rst create mode 100644 docs/generated/suou.codecs.rst create mode 100644 docs/generated/suou.collections.rst create mode 100644 docs/generated/suou.color.rst create mode 100644 docs/generated/suou.configparse.rst create mode 100644 docs/generated/suou.dei.rst create mode 100644 docs/generated/suou.dorks.rst create mode 100644 docs/generated/suou.exceptions.rst create mode 100644 docs/generated/suou.flask.rst create mode 100644 docs/generated/suou.flask_restx.rst create mode 100644 docs/generated/suou.flask_sqlalchemy.rst create mode 100644 docs/generated/suou.functools.rst create mode 100644 docs/generated/suou.http.rst create mode 100644 docs/generated/suou.i18n.rst create mode 100644 docs/generated/suou.iding.rst create mode 100644 docs/generated/suou.itertools.rst create mode 100644 docs/generated/suou.legal.rst create mode 100644 docs/generated/suou.lex.rst create mode 100644 docs/generated/suou.luck.rst create mode 100644 docs/generated/suou.markdown.rst create mode 100644 docs/generated/suou.migrate.rst create mode 100644 docs/generated/suou.quart.rst create mode 100644 docs/generated/suou.redact.rst create mode 100644 docs/generated/suou.rst create mode 100644 docs/generated/suou.sass.rst create mode 100644 docs/generated/suou.signing.rst create mode 100644 docs/generated/suou.snowflake.rst create mode 100644 docs/generated/suou.sqlalchemy.rst create mode 100644 docs/generated/suou.strtools.rst create mode 100644 docs/generated/suou.terminal.rst create mode 100644 docs/generated/suou.validators.rst create mode 100644 docs/generated/suou.waiter.rst create mode 100644 docs/index.rst create mode 100644 docs/make.bat diff --git a/.gitignore b/.gitignore index 31cd9f7..5736b26 100644 --- a/.gitignore +++ b/.gitignore @@ -26,3 +26,6 @@ dist/ /run.sh ROADMAP.md aliases/*/src +docs/_build +docs/_static +docs/templates \ No newline at end of file diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 0000000..3403857 --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,10 @@ +version: 2 + +build: + os: ubuntu-24.04 + tools: + python: "3.13" + +sphinx: + configuration: docs/conf.py + diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 0000000..d4bb2cb --- /dev/null +++ b/docs/Makefile @@ -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 = . +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) diff --git a/docs/api.rst b/docs/api.rst new file mode 100644 index 0000000..1a515aa --- /dev/null +++ b/docs/api.rst @@ -0,0 +1,41 @@ +API +=== + +.. autosummary:: + :toctree: generated + + suou.sqlalchemy + suou.asgi + suou.bits + suou.calendar + suou.classtools + suou.codecs + suou.collections + suou.color + suou.configparse + suou.dei + suou.dorks + suou.exceptions + suou.flask_restx + suou.flask_sqlalchemy + suou.flask + suou.functools + suou.http + suou.i18n + suou.iding + suou.itertools + suou.legal + suou.lex + suou.luck + suou.markdown + suou.migrate + suou.peewee + suou.quart + suou.redact + suou.sass + suou.signing + suou.snowflake + suou.strtools + suou.terminal + suou.validators + suou.waiter \ No newline at end of file diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 0000000..102befd --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,30 @@ +# 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 + +import sys +from pathlib import Path + +sys.path.insert(0, str(Path("..", "src").resolve())) + +project = 'suou' +copyright = '2025 Sakuragasaki46' +author = 'Sakuragasaki46' + +# -- General configuration --------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration + +extensions = ["sphinx.ext.autodoc", 'sphinx.ext.autosummary', 'myst_parser'] + +templates_path = ['_templates'] +exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] + +# -- Options for HTML output ------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output + +html_theme = 'alabaster' +html_static_path = ['_static'] diff --git a/docs/generated/suou.asgi.rst b/docs/generated/suou.asgi.rst new file mode 100644 index 0000000..00c5839 --- /dev/null +++ b/docs/generated/suou.asgi.rst @@ -0,0 +1,6 @@ +suou.asgi +========= + +.. automodule:: suou.asgi + + \ No newline at end of file diff --git a/docs/generated/suou.bits.rst b/docs/generated/suou.bits.rst new file mode 100644 index 0000000..d8b4a3e --- /dev/null +++ b/docs/generated/suou.bits.rst @@ -0,0 +1,17 @@ +suou.bits +========= + +.. automodule:: suou.bits + + + .. rubric:: Functions + + .. autosummary:: + + count_ones + join_bits + mask_shift + mod_ceil + mod_floor + split_bits + \ No newline at end of file diff --git a/docs/generated/suou.calendar.rst b/docs/generated/suou.calendar.rst new file mode 100644 index 0000000..510743d --- /dev/null +++ b/docs/generated/suou.calendar.rst @@ -0,0 +1,16 @@ +suou.calendar +============= + +.. automodule:: suou.calendar + + + .. rubric:: Functions + + .. autosummary:: + + age_and_days + parse_time + want_datetime + want_isodate + want_timestamp + \ No newline at end of file diff --git a/docs/generated/suou.classtools.rst b/docs/generated/suou.classtools.rst new file mode 100644 index 0000000..db0a16a --- /dev/null +++ b/docs/generated/suou.classtools.rst @@ -0,0 +1,16 @@ +suou.classtools +=============== + +.. automodule:: suou.classtools + + + .. rubric:: Classes + + .. autosummary:: + + Incomplete + MissingType + ValueProperty + ValueSource + Wanted + \ No newline at end of file diff --git a/docs/generated/suou.codecs.rst b/docs/generated/suou.codecs.rst new file mode 100644 index 0000000..bfd0260 --- /dev/null +++ b/docs/generated/suou.codecs.rst @@ -0,0 +1,36 @@ +suou.codecs +=========== + +.. automodule:: suou.codecs + + + .. rubric:: Functions + + .. autosummary:: + + b2048decode + b2048encode + b32ldecode + b32lencode + b64decode + b64encode + cb32decode + cb32encode + jsonencode + quote_css_string + rb64decode + rb64encode + ssv_list + twocolon_list + want_bytes + want_str + want_urlsafe + want_urlsafe_bytes + z85encode + + .. rubric:: Classes + + .. autosummary:: + + StringCase + \ No newline at end of file diff --git a/docs/generated/suou.collections.rst b/docs/generated/suou.collections.rst new file mode 100644 index 0000000..57899fd --- /dev/null +++ b/docs/generated/suou.collections.rst @@ -0,0 +1,12 @@ +suou.collections +================ + +.. automodule:: suou.collections + + + .. rubric:: Classes + + .. autosummary:: + + TimedDict + \ No newline at end of file diff --git a/docs/generated/suou.color.rst b/docs/generated/suou.color.rst new file mode 100644 index 0000000..b87aaa4 --- /dev/null +++ b/docs/generated/suou.color.rst @@ -0,0 +1,13 @@ +suou.color +========== + +.. automodule:: suou.color + + + .. rubric:: Classes + + .. autosummary:: + + Chalk + WebColor + \ No newline at end of file diff --git a/docs/generated/suou.configparse.rst b/docs/generated/suou.configparse.rst new file mode 100644 index 0000000..ea6c6ad --- /dev/null +++ b/docs/generated/suou.configparse.rst @@ -0,0 +1,18 @@ +suou.configparse +================ + +.. automodule:: suou.configparse + + + .. rubric:: Classes + + .. autosummary:: + + ArgConfigSource + ConfigOptions + ConfigParserConfigSource + ConfigSource + ConfigValue + DictConfigSource + EnvConfigSource + \ No newline at end of file diff --git a/docs/generated/suou.dei.rst b/docs/generated/suou.dei.rst new file mode 100644 index 0000000..5604f14 --- /dev/null +++ b/docs/generated/suou.dei.rst @@ -0,0 +1,24 @@ +suou.dei +======== + +.. automodule:: suou.dei + + + .. rubric:: Module Attributes + + .. autosummary:: + + BRICKS + + .. rubric:: Functions + + .. autosummary:: + + dei_args + + .. rubric:: Classes + + .. autosummary:: + + Pronoun + \ No newline at end of file diff --git a/docs/generated/suou.dorks.rst b/docs/generated/suou.dorks.rst new file mode 100644 index 0000000..ec092e7 --- /dev/null +++ b/docs/generated/suou.dorks.rst @@ -0,0 +1,6 @@ +suou.dorks +========== + +.. automodule:: suou.dorks + + \ No newline at end of file diff --git a/docs/generated/suou.exceptions.rst b/docs/generated/suou.exceptions.rst new file mode 100644 index 0000000..8f42c2d --- /dev/null +++ b/docs/generated/suou.exceptions.rst @@ -0,0 +1,24 @@ +suou.exceptions +=============== + +.. automodule:: suou.exceptions + + + .. rubric:: Exceptions + + .. autosummary:: + + BabelTowerError + BadLuckError + BrokenStringsError + Fahrenheit451Error + FuckAroundFindOutError + InconsistencyError + LexError + MissingConfigError + MissingConfigWarning + NotFoundError + PoliticalError + PoliticalWarning + TerminalRequiredError + \ No newline at end of file diff --git a/docs/generated/suou.flask.rst b/docs/generated/suou.flask.rst new file mode 100644 index 0000000..42193eb --- /dev/null +++ b/docs/generated/suou.flask.rst @@ -0,0 +1,16 @@ +suou.flask +========== + +.. automodule:: suou.flask + + + .. rubric:: Functions + + .. autosummary:: + + add_context_from_config + add_i18n + get_flask_conf + harden + negotiate + \ No newline at end of file diff --git a/docs/generated/suou.flask_restx.rst b/docs/generated/suou.flask_restx.rst new file mode 100644 index 0000000..e02d399 --- /dev/null +++ b/docs/generated/suou.flask_restx.rst @@ -0,0 +1,18 @@ +suou.flask\_restx +================= + +.. automodule:: suou.flask_restx + + + .. rubric:: Functions + + .. autosummary:: + + output_json + + .. rubric:: Classes + + .. autosummary:: + + Api + \ No newline at end of file diff --git a/docs/generated/suou.flask_sqlalchemy.rst b/docs/generated/suou.flask_sqlalchemy.rst new file mode 100644 index 0000000..e89c0bf --- /dev/null +++ b/docs/generated/suou.flask_sqlalchemy.rst @@ -0,0 +1,18 @@ +suou.flask\_sqlalchemy +====================== + +.. automodule:: suou.flask_sqlalchemy + + + .. rubric:: Functions + + .. autosummary:: + + require_auth + + .. rubric:: Classes + + .. autosummary:: + + FlaskAuthSrc + \ No newline at end of file diff --git a/docs/generated/suou.functools.rst b/docs/generated/suou.functools.rst new file mode 100644 index 0000000..6035dff --- /dev/null +++ b/docs/generated/suou.functools.rst @@ -0,0 +1,18 @@ +suou.functools +============== + +.. automodule:: suou.functools + + + .. rubric:: Functions + + .. autosummary:: + + alru_cache + deprecated_alias + flat_args + future + none_pass + not_implemented + timed_cache + \ No newline at end of file diff --git a/docs/generated/suou.http.rst b/docs/generated/suou.http.rst new file mode 100644 index 0000000..82c9332 --- /dev/null +++ b/docs/generated/suou.http.rst @@ -0,0 +1,12 @@ +suou.http +========= + +.. automodule:: suou.http + + + .. rubric:: Classes + + .. autosummary:: + + WantsContentType + \ No newline at end of file diff --git a/docs/generated/suou.i18n.rst b/docs/generated/suou.i18n.rst new file mode 100644 index 0000000..7f92f78 --- /dev/null +++ b/docs/generated/suou.i18n.rst @@ -0,0 +1,16 @@ +suou.i18n +========= + +.. automodule:: suou.i18n + + + .. rubric:: Classes + + .. autosummary:: + + I18n + I18nLang + IdentityLang + JsonI18n + TomlI18n + \ No newline at end of file diff --git a/docs/generated/suou.iding.rst b/docs/generated/suou.iding.rst new file mode 100644 index 0000000..a47d428 --- /dev/null +++ b/docs/generated/suou.iding.rst @@ -0,0 +1,22 @@ +suou.iding +========== + +.. automodule:: suou.iding + + + .. rubric:: Functions + + .. autosummary:: + + make_domain_hash + + .. rubric:: Classes + + .. autosummary:: + + Siq + SiqCache + SiqFormatType + SiqGen + SiqType + \ No newline at end of file diff --git a/docs/generated/suou.itertools.rst b/docs/generated/suou.itertools.rst new file mode 100644 index 0000000..3ee27ab --- /dev/null +++ b/docs/generated/suou.itertools.rst @@ -0,0 +1,23 @@ +suou.itertools +============== + +.. automodule:: suou.itertools + + + .. rubric:: Functions + + .. autosummary:: + + addattr + additem + kwargs_prefix + ltuple + makelist + rtuple + + .. rubric:: Classes + + .. autosummary:: + + hashed_list + \ No newline at end of file diff --git a/docs/generated/suou.legal.rst b/docs/generated/suou.legal.rst new file mode 100644 index 0000000..e119f97 --- /dev/null +++ b/docs/generated/suou.legal.rst @@ -0,0 +1,6 @@ +suou.legal +========== + +.. automodule:: suou.legal + + \ No newline at end of file diff --git a/docs/generated/suou.lex.rst b/docs/generated/suou.lex.rst new file mode 100644 index 0000000..6a49b80 --- /dev/null +++ b/docs/generated/suou.lex.rst @@ -0,0 +1,6 @@ +suou.lex +======== + +.. currentmodule:: suou + +.. autofunction:: lex \ No newline at end of file diff --git a/docs/generated/suou.luck.rst b/docs/generated/suou.luck.rst new file mode 100644 index 0000000..9480188 --- /dev/null +++ b/docs/generated/suou.luck.rst @@ -0,0 +1,19 @@ +suou.luck +========= + +.. automodule:: suou.luck + + + .. rubric:: Functions + + .. autosummary:: + + lucky + rng_overload + + .. rubric:: Classes + + .. autosummary:: + + RngCallable + \ No newline at end of file diff --git a/docs/generated/suou.markdown.rst b/docs/generated/suou.markdown.rst new file mode 100644 index 0000000..5476d20 --- /dev/null +++ b/docs/generated/suou.markdown.rst @@ -0,0 +1,16 @@ +suou.markdown +============= + +.. automodule:: suou.markdown + + + .. rubric:: Classes + + .. autosummary:: + + MentionPattern + PingExtension + SpoilerExtension + StrikethroughExtension + StrikethroughPostprocessor + \ No newline at end of file diff --git a/docs/generated/suou.migrate.rst b/docs/generated/suou.migrate.rst new file mode 100644 index 0000000..2b35157 --- /dev/null +++ b/docs/generated/suou.migrate.rst @@ -0,0 +1,14 @@ +suou.migrate +============ + +.. automodule:: suou.migrate + + + .. rubric:: Classes + + .. autosummary:: + + SiqMigrator + SnowflakeSiqMigrator + UlidSiqMigrator + \ No newline at end of file diff --git a/docs/generated/suou.quart.rst b/docs/generated/suou.quart.rst new file mode 100644 index 0000000..9be2817 --- /dev/null +++ b/docs/generated/suou.quart.rst @@ -0,0 +1,14 @@ +suou.quart +========== + +.. automodule:: suou.quart + + + .. rubric:: Functions + + .. autosummary:: + + add_i18n + add_rest + negotiate + \ No newline at end of file diff --git a/docs/generated/suou.redact.rst b/docs/generated/suou.redact.rst new file mode 100644 index 0000000..b5208ec --- /dev/null +++ b/docs/generated/suou.redact.rst @@ -0,0 +1,12 @@ +suou.redact +=========== + +.. automodule:: suou.redact + + + .. rubric:: Functions + + .. autosummary:: + + redact_url_password + \ No newline at end of file diff --git a/docs/generated/suou.rst b/docs/generated/suou.rst new file mode 100644 index 0000000..5533886 --- /dev/null +++ b/docs/generated/suou.rst @@ -0,0 +1,6 @@ +suou +==== + +.. automodule:: suou + + \ No newline at end of file diff --git a/docs/generated/suou.sass.rst b/docs/generated/suou.sass.rst new file mode 100644 index 0000000..6ad4426 --- /dev/null +++ b/docs/generated/suou.sass.rst @@ -0,0 +1,12 @@ +suou.sass +========= + +.. automodule:: suou.sass + + + .. rubric:: Classes + + .. autosummary:: + + SassAsyncMiddleware + \ No newline at end of file diff --git a/docs/generated/suou.signing.rst b/docs/generated/suou.signing.rst new file mode 100644 index 0000000..b57968d --- /dev/null +++ b/docs/generated/suou.signing.rst @@ -0,0 +1,13 @@ +suou.signing +============ + +.. automodule:: suou.signing + + + .. rubric:: Classes + + .. autosummary:: + + HasSigner + UserSigner + \ No newline at end of file diff --git a/docs/generated/suou.snowflake.rst b/docs/generated/suou.snowflake.rst new file mode 100644 index 0000000..fa072d3 --- /dev/null +++ b/docs/generated/suou.snowflake.rst @@ -0,0 +1,13 @@ +suou.snowflake +============== + +.. automodule:: suou.snowflake + + + .. rubric:: Classes + + .. autosummary:: + + Snowflake + SnowflakeGen + \ No newline at end of file diff --git a/docs/generated/suou.sqlalchemy.rst b/docs/generated/suou.sqlalchemy.rst new file mode 100644 index 0000000..118bf3a --- /dev/null +++ b/docs/generated/suou.sqlalchemy.rst @@ -0,0 +1,20 @@ +suou.sqlalchemy +=============== + +.. automodule:: suou.sqlalchemy + + + .. rubric:: Functions + + .. autosummary:: + + create_session + require_auth_base + token_signer + + .. rubric:: Classes + + .. autosummary:: + + AuthSrc + \ No newline at end of file diff --git a/docs/generated/suou.strtools.rst b/docs/generated/suou.strtools.rst new file mode 100644 index 0000000..c9df5c0 --- /dev/null +++ b/docs/generated/suou.strtools.rst @@ -0,0 +1,12 @@ +suou.strtools +============= + +.. automodule:: suou.strtools + + + .. rubric:: Classes + + .. autosummary:: + + PrefixIdentifier + \ No newline at end of file diff --git a/docs/generated/suou.terminal.rst b/docs/generated/suou.terminal.rst new file mode 100644 index 0000000..71d531f --- /dev/null +++ b/docs/generated/suou.terminal.rst @@ -0,0 +1,12 @@ +suou.terminal +============= + +.. automodule:: suou.terminal + + + .. rubric:: Functions + + .. autosummary:: + + terminal_required + \ No newline at end of file diff --git a/docs/generated/suou.validators.rst b/docs/generated/suou.validators.rst new file mode 100644 index 0000000..673e889 --- /dev/null +++ b/docs/generated/suou.validators.rst @@ -0,0 +1,15 @@ +suou.validators +=============== + +.. automodule:: suou.validators + + + .. rubric:: Functions + + .. autosummary:: + + matches + must_be + not_greater_than + not_less_than + \ No newline at end of file diff --git a/docs/generated/suou.waiter.rst b/docs/generated/suou.waiter.rst new file mode 100644 index 0000000..c668f25 --- /dev/null +++ b/docs/generated/suou.waiter.rst @@ -0,0 +1,19 @@ +suou.waiter +=========== + +.. automodule:: suou.waiter + + + .. rubric:: Functions + + .. autosummary:: + + ko + ok + + .. rubric:: Classes + + .. autosummary:: + + Waiter + \ No newline at end of file diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 0000000..3bc5bd4 --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,18 @@ +.. suou documentation master file, created by + sphinx-quickstart on Fri Oct 10 19:24:23 2025. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +suou documentation +================== + +SUOU (acronym for ) is a casual Python library providing utilities to +ease programmer's QoL. + + + + +.. toctree:: + :maxdepth: 2 + + api \ No newline at end of file diff --git a/docs/make.bat b/docs/make.bat new file mode 100644 index 0000000..32bb245 --- /dev/null +++ b/docs/make.bat @@ -0,0 +1,35 @@ +@ECHO OFF + +pushd %~dp0 + +REM Command file for Sphinx documentation + +if "%SPHINXBUILD%" == "" ( + set SPHINXBUILD=sphinx-build +) +set SOURCEDIR=. +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 diff --git a/src/suou/__init__.py b/src/suou/__init__.py index dd48e57..66f3fcd 100644 --- a/src/suou/__init__.py +++ b/src/suou/__init__.py @@ -37,7 +37,7 @@ from .redact import redact_url_password from .http import WantsContentType from .color import chalk -__version__ = "0.7.0" +__version__ = "0.7.1-dev40" __all__ = ( 'ConfigOptions', 'ConfigParserConfigSource', 'ConfigSource', 'ConfigValue',