| リビジョン | ce9b569c9f702351474b97f272c3576695a83993 (tree) |
|---|---|
| 日時 | 2019-08-26 07:54:24 |
| 作者 |  H. Turgut Uyar <uyar@teki...> |
| コミッター | H. Turgut Uyar |
Add documentation skeleton
.hgignore (diff) poetry.lock (diff) pyproject.toml (diff) docs/Makefile (diff) docs/source/_static/.hgkeep (diff)
docs/source/conf.py (diff) docs/source/index.rst (diff)| @@ -4,6 +4,7 @@ | ||
| 4 | 4 | *.pyc |
| 5 | 5 | *.egg-info |
| 6 | 6 | |
| 7 | +build | |
| 7 | 8 | dist |
| 8 | 9 | |
| 9 | 10 | .venv |
| @@ -0,0 +1,19 @@ | ||
| 1 | +# Minimal makefile for Sphinx documentation | |
| 2 | +# | |
| 3 | + | |
| 4 | +# You can set these variables from the command line. | |
| 5 | +SPHINXOPTS = | |
| 6 | +SPHINXBUILD = sphinx-build | |
| 7 | +SOURCEDIR = source | |
| 8 | +BUILDDIR = build | |
| 9 | + | |
| 10 | +# Put it first so that "make" without argument is like "make help". | |
| 11 | +help: | |
| 12 | + @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) | |
| 13 | + | |
| 14 | +.PHONY: help Makefile | |
| 15 | + | |
| 16 | +# Catch-all target: route all unknown targets to Sphinx using the new | |
| 17 | +# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). | |
| 18 | +%: Makefile | |
| 19 | + @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) | |
| \ No newline at end of file |
| @@ -0,0 +1,57 @@ | ||
| 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 | +# http://www.sphinx-doc.org/en/master/config | |
| 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 | +# sys.path.insert(0, os.path.abspath('.')) | |
| 16 | + | |
| 17 | + | |
| 18 | +# -- Project information ----------------------------------------------------- | |
| 19 | + | |
| 20 | +project = 'Humphrey' | |
| 21 | +copyright = '2019, H. Turgut Uyar' | |
| 22 | +author = 'H. Turgut Uyar' | |
| 23 | + | |
| 24 | +# The full version, including alpha/beta/rc tags | |
| 25 | +release = '0.1' | |
| 26 | + | |
| 27 | + | |
| 28 | +# -- General configuration --------------------------------------------------- | |
| 29 | + | |
| 30 | +# Add any Sphinx extension module names here, as strings. They can be | |
| 31 | +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom | |
| 32 | +# ones. | |
| 33 | +extensions = [ | |
| 34 | + 'sphinx.ext.autodoc', | |
| 35 | + 'pygenstub' | |
| 36 | +] | |
| 37 | + | |
| 38 | +# Add any paths that contain templates here, relative to this directory. | |
| 39 | +templates_path = ['_templates'] | |
| 40 | + | |
| 41 | +# List of patterns, relative to source directory, that match files and | |
| 42 | +# directories to ignore when looking for source files. | |
| 43 | +# This pattern also affects html_static_path and html_extra_path. | |
| 44 | +exclude_patterns = [] | |
| 45 | + | |
| 46 | + | |
| 47 | +# -- Options for HTML output ------------------------------------------------- | |
| 48 | + | |
| 49 | +# The theme to use for HTML and HTML Help pages. See the documentation for | |
| 50 | +# a list of builtin themes. | |
| 51 | +# | |
| 52 | +html_theme = 'sphinx_rtd_theme' | |
| 53 | + | |
| 54 | +# Add any paths that contain custom static files (such as style sheets) here, | |
| 55 | +# relative to this directory. They are copied after the builtin static files, | |
| 56 | +# so a file named "default.css" will overwrite the builtin "default.css". | |
| 57 | +html_static_path = ['_static'] |
| @@ -0,0 +1,20 @@ | ||
| 1 | +.. Humphrey documentation master file, created by | |
| 2 | + sphinx-quickstart on Mon Apr 8 19:40:29 2019. | |
| 3 | + You can adapt this file completely to your liking, but it should at least | |
| 4 | + contain the root `toctree` directive. | |
| 5 | + | |
| 6 | +Welcome to Humphrey's documentation! | |
| 7 | +==================================== | |
| 8 | + | |
| 9 | +.. toctree:: | |
| 10 | + :maxdepth: 2 | |
| 11 | + :caption: Contents: | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | +Indices and tables | |
| 16 | +================== | |
| 17 | + | |
| 18 | +* :ref:`genindex` | |
| 19 | +* :ref:`modindex` | |
| 20 | +* :ref:`search` |
| @@ -1,3 +1,11 @@ | ||
| 1 | +[[package]] | |
| 2 | +category = "dev" | |
| 3 | +description = "A configurable sidebar-enabled Sphinx theme" | |
| 4 | +name = "alabaster" | |
| 5 | +optional = false | |
| 6 | +python-versions = "*" | |
| 7 | +version = "0.7.12" | |
| 8 | + | |
| 1 | 9 | [[package]] |
| 2 | 10 | category = "dev" |
| 3 | 11 | description = "Atomic file writes." |
| @@ -21,6 +29,33 @@ | ||
| 21 | 29 | |
| 22 | 30 | [[package]] |
| 23 | 31 | category = "dev" |
| 32 | +description = "Internationalization utilities" | |
| 33 | +name = "babel" | |
| 34 | +optional = false | |
| 35 | +python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*" | |
| 36 | +version = "2.7.0" | |
| 37 | + | |
| 38 | +[package.dependencies] | |
| 39 | +pytz = ">=2015.7" | |
| 40 | + | |
| 41 | +[[package]] | |
| 42 | +category = "dev" | |
| 43 | +description = "Python package for providing Mozilla's CA Bundle." | |
| 44 | +name = "certifi" | |
| 45 | +optional = false | |
| 46 | +python-versions = "*" | |
| 47 | +version = "2019.6.16" | |
| 48 | + | |
| 49 | +[[package]] | |
| 50 | +category = "dev" | |
| 51 | +description = "Universal encoding detector for Python 2 and 3" | |
| 52 | +name = "chardet" | |
| 53 | +optional = false | |
| 54 | +python-versions = "*" | |
| 55 | +version = "3.0.4" | |
| 56 | + | |
| 57 | +[[package]] | |
| 58 | +category = "dev" | |
| 24 | 59 | description = "Cross-platform colored terminal text." |
| 25 | 60 | marker = "sys_platform == \"win32\"" |
| 26 | 61 | name = "colorama" |
| @@ -108,6 +143,22 @@ | ||
| 108 | 143 | |
| 109 | 144 | [[package]] |
| 110 | 145 | category = "dev" |
| 146 | +description = "Internationalized Domain Names in Applications (IDNA)" | |
| 147 | +name = "idna" | |
| 148 | +optional = false | |
| 149 | +python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*" | |
| 150 | +version = "2.8" | |
| 151 | + | |
| 152 | +[[package]] | |
| 153 | +category = "dev" | |
| 154 | +description = "Getting image size from png/jpeg/jpeg2000/gif file" | |
| 155 | +name = "imagesize" | |
| 156 | +optional = false | |
| 157 | +python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*" | |
| 158 | +version = "1.1.0" | |
| 159 | + | |
| 160 | +[[package]] | |
| 161 | +category = "dev" | |
| 111 | 162 | description = "Read metadata from Python packages" |
| 112 | 163 | name = "importlib-metadata" |
| 113 | 164 | optional = false |
| @@ -137,6 +188,28 @@ | ||
| 137 | 188 | |
| 138 | 189 | [[package]] |
| 139 | 190 | category = "dev" |
| 191 | +description = "A small but fast and easy to use stand-alone template engine written in pure python." | |
| 192 | +name = "jinja2" | |
| 193 | +optional = false | |
| 194 | +python-versions = "*" | |
| 195 | +version = "2.10.1" | |
| 196 | + | |
| 197 | +[package.dependencies] | |
| 198 | +MarkupSafe = ">=0.23" | |
| 199 | + | |
| 200 | +[package.extras] | |
| 201 | +i18n = ["Babel (>=0.8)"] | |
| 202 | + | |
| 203 | +[[package]] | |
| 204 | +category = "dev" | |
| 205 | +description = "Safely add untrusted strings to HTML/XML markup." | |
| 206 | +name = "markupsafe" | |
| 207 | +optional = false | |
| 208 | +python-versions = ">=2.7,!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*" | |
| 209 | +version = "1.1.1" | |
| 210 | + | |
| 211 | +[[package]] | |
| 212 | +category = "dev" | |
| 140 | 213 | description = "McCabe checker, plugin for flake8" |
| 141 | 214 | name = "mccabe" |
| 142 | 215 | optional = false |
| @@ -238,6 +311,14 @@ | ||
| 238 | 311 | |
| 239 | 312 | [[package]] |
| 240 | 313 | category = "dev" |
| 314 | +description = "Pygments is a syntax highlighting package written in Python." | |
| 315 | +name = "pygments" | |
| 316 | +optional = false | |
| 317 | +python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*" | |
| 318 | +version = "2.4.2" | |
| 319 | + | |
| 320 | +[[package]] | |
| 321 | +category = "dev" | |
| 241 | 322 | description = "Python parsing module" |
| 242 | 323 | name = "pyparsing" |
| 243 | 324 | optional = false |
| @@ -290,6 +371,32 @@ | ||
| 290 | 371 | |
| 291 | 372 | [[package]] |
| 292 | 373 | category = "dev" |
| 374 | +description = "World timezone definitions, modern and historical" | |
| 375 | +name = "pytz" | |
| 376 | +optional = false | |
| 377 | +python-versions = "*" | |
| 378 | +version = "2019.2" | |
| 379 | + | |
| 380 | +[[package]] | |
| 381 | +category = "dev" | |
| 382 | +description = "Python HTTP for Humans." | |
| 383 | +name = "requests" | |
| 384 | +optional = false | |
| 385 | +python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*" | |
| 386 | +version = "2.22.0" | |
| 387 | + | |
| 388 | +[package.dependencies] | |
| 389 | +certifi = ">=2017.4.17" | |
| 390 | +chardet = ">=3.0.2,<3.1.0" | |
| 391 | +idna = ">=2.5,<2.9" | |
| 392 | +urllib3 = ">=1.21.1,<1.25.0 || >1.25.0,<1.25.1 || >1.25.1,<1.26" | |
| 393 | + | |
| 394 | +[package.extras] | |
| 395 | +security = ["pyOpenSSL (>=0.14)", "cryptography (>=1.3.4)", "idna (>=2.0.0)"] | |
| 396 | +socks = ["PySocks (>=1.5.6,<1.5.7 || >1.5.7)", "win-inet-pton"] | |
| 397 | + | |
| 398 | +[[package]] | |
| 399 | +category = "dev" | |
| 293 | 400 | description = "Python 2 and 3 compatibility utilities" |
| 294 | 401 | name = "six" |
| 295 | 402 | optional = false |
| @@ -306,6 +413,114 @@ | ||
| 306 | 413 | |
| 307 | 414 | [[package]] |
| 308 | 415 | category = "dev" |
| 416 | +description = "Python documentation generator" | |
| 417 | +name = "sphinx" | |
| 418 | +optional = false | |
| 419 | +python-versions = ">=3.5" | |
| 420 | +version = "2.2.0" | |
| 421 | + | |
| 422 | +[package.dependencies] | |
| 423 | +Jinja2 = ">=2.3" | |
| 424 | +Pygments = ">=2.0" | |
| 425 | +alabaster = ">=0.7,<0.8" | |
| 426 | +babel = ">=1.3,<2.0 || >2.0" | |
| 427 | +colorama = ">=0.3.5" | |
| 428 | +docutils = ">=0.12" | |
| 429 | +imagesize = "*" | |
| 430 | +packaging = "*" | |
| 431 | +requests = ">=2.5.0" | |
| 432 | +setuptools = "*" | |
| 433 | +snowballstemmer = ">=1.1" | |
| 434 | +sphinxcontrib-applehelp = "*" | |
| 435 | +sphinxcontrib-devhelp = "*" | |
| 436 | +sphinxcontrib-htmlhelp = "*" | |
| 437 | +sphinxcontrib-jsmath = "*" | |
| 438 | +sphinxcontrib-qthelp = "*" | |
| 439 | +sphinxcontrib-serializinghtml = "*" | |
| 440 | + | |
| 441 | +[package.extras] | |
| 442 | +docs = ["sphinxcontrib-websupport"] | |
| 443 | +test = ["pytest", "pytest-cov", "html5lib", "flake8 (>=3.5.0)", "flake8-import-order", "mypy (>=0.720)", "docutils-stubs"] | |
| 444 | + | |
| 445 | +[[package]] | |
| 446 | +category = "dev" | |
| 447 | +description = "Read the Docs theme for Sphinx" | |
| 448 | +name = "sphinx-rtd-theme" | |
| 449 | +optional = false | |
| 450 | +python-versions = "*" | |
| 451 | +version = "0.4.3" | |
| 452 | + | |
| 453 | +[package.dependencies] | |
| 454 | +sphinx = "*" | |
| 455 | + | |
| 456 | +[[package]] | |
| 457 | +category = "dev" | |
| 458 | +description = "" | |
| 459 | +name = "sphinxcontrib-applehelp" | |
| 460 | +optional = false | |
| 461 | +python-versions = "*" | |
| 462 | +version = "1.0.1" | |
| 463 | + | |
| 464 | +[package.extras] | |
| 465 | +test = ["pytest", "flake8", "mypy"] | |
| 466 | + | |
| 467 | +[[package]] | |
| 468 | +category = "dev" | |
| 469 | +description = "" | |
| 470 | +name = "sphinxcontrib-devhelp" | |
| 471 | +optional = false | |
| 472 | +python-versions = "*" | |
| 473 | +version = "1.0.1" | |
| 474 | + | |
| 475 | +[package.extras] | |
| 476 | +test = ["pytest", "flake8", "mypy"] | |
| 477 | + | |
| 478 | +[[package]] | |
| 479 | +category = "dev" | |
| 480 | +description = "" | |
| 481 | +name = "sphinxcontrib-htmlhelp" | |
| 482 | +optional = false | |
| 483 | +python-versions = "*" | |
| 484 | +version = "1.0.2" | |
| 485 | + | |
| 486 | +[package.extras] | |
| 487 | +test = ["pytest", "flake8", "mypy", "html5lib"] | |
| 488 | + | |
| 489 | +[[package]] | |
| 490 | +category = "dev" | |
| 491 | +description = "A sphinx extension which renders display math in HTML via JavaScript" | |
| 492 | +name = "sphinxcontrib-jsmath" | |
| 493 | +optional = false | |
| 494 | +python-versions = ">=3.5" | |
| 495 | +version = "1.0.1" | |
| 496 | + | |
| 497 | +[package.extras] | |
| 498 | +test = ["pytest", "flake8", "mypy"] | |
| 499 | + | |
| 500 | +[[package]] | |
| 501 | +category = "dev" | |
| 502 | +description = "" | |
| 503 | +name = "sphinxcontrib-qthelp" | |
| 504 | +optional = false | |
| 505 | +python-versions = "*" | |
| 506 | +version = "1.0.2" | |
| 507 | + | |
| 508 | +[package.extras] | |
| 509 | +test = ["pytest", "flake8", "mypy"] | |
| 510 | + | |
| 511 | +[[package]] | |
| 512 | +category = "dev" | |
| 513 | +description = "" | |
| 514 | +name = "sphinxcontrib-serializinghtml" | |
| 515 | +optional = false | |
| 516 | +python-versions = "*" | |
| 517 | +version = "1.1.3" | |
| 518 | + | |
| 519 | +[package.extras] | |
| 520 | +test = ["pytest", "flake8", "mypy"] | |
| 521 | + | |
| 522 | +[[package]] | |
| 523 | +category = "dev" | |
| 309 | 524 | description = "A collection of helpers and mock objects for unit tests and doc tests." |
| 310 | 525 | name = "testfixtures" |
| 311 | 526 | optional = false |
| @@ -319,6 +534,19 @@ | ||
| 319 | 534 | |
| 320 | 535 | [[package]] |
| 321 | 536 | category = "dev" |
| 537 | +description = "HTTP library with thread-safe connection pooling, file post, and more." | |
| 538 | +name = "urllib3" | |
| 539 | +optional = false | |
| 540 | +python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, <4" | |
| 541 | +version = "1.25.3" | |
| 542 | + | |
| 543 | +[package.extras] | |
| 544 | +brotli = ["brotlipy (>=0.6.0)"] | |
| 545 | +secure = ["pyOpenSSL (>=0.14)", "cryptography (>=1.3.4)", "idna (>=2.0.0)", "certifi", "ipaddress"] | |
| 546 | +socks = ["PySocks (>=1.5.6,<1.5.7 || >1.5.7,<2.0)"] | |
| 547 | + | |
| 548 | +[[package]] | |
| 549 | +category = "dev" | |
| 322 | 550 | description = "Measures number of Terminal column cells of wide-character codes" |
| 323 | 551 | name = "wcwidth" |
| 324 | 552 | optional = false |
| @@ -341,12 +569,16 @@ | ||
| 341 | 569 | testing = ["pathlib2", "contextlib2", "unittest2"] |
| 342 | 570 | |
| 343 | 571 | [metadata] |
| 344 | -content-hash = "0a56e4f69cd80f08ae83f439c81d8f0b42d3291d5139c39423b34f00c9b209d8" | |
| 572 | +content-hash = "8ea140af930eb3c257cf0df40fbcadbc48a5108a6b70367990f18c6cf2411dca" | |
| 345 | 573 | python-versions = "^3.5" |
| 346 | 574 | |
| 347 | 575 | [metadata.hashes] |
| 576 | +alabaster = ["446438bdcca0e05bd45ea2de1668c1d9b032e1a9154c2c259092d77031ddd359", "a661d72d58e6ea8a57f7a86e37d86716863ee5e92788398526d58b26a4e4dc02"] | |
| 348 | 577 | atomicwrites = ["03472c30eb2c5d1ba9227e4c2ca66ab8287fbfbbda3888aa93dc2e28fc6811b4", "75a9445bac02d8d058d5e1fe689654ba5a6556a1dfd8ce6ec55a0ed79866cfa6"] |
| 349 | 578 | attrs = ["69c0dbf2ed392de1cb5ec704444b08a5ef81680a61cb899dc08127123af36a79", "f0b870f674851ecbfbbbd364d6b5cbdff9dcedbc7f3f5e18a6891057f21fe399"] |
| 579 | +babel = ["af92e6106cb7c55286b25b38ad7695f8b4efb36a90ba483d7f7a6628c46158ab", "e86135ae101e31e2c8ec20a4e0c5220f4eed12487d5cf3f78be7e98d3a57fc28"] | |
| 580 | +certifi = ["046832c04d4e752f37383b628bc601a7ea7211496b4638f6514d0e5b9acc4939", "945e3ba63a0b9f577b1395204e13c3a231f9bc0223888be653286534e5873695"] | |
| 581 | +chardet = ["84ab92ed1c4d4f16916e05906b6b75a6c0fb5db821cc65e70cbd64a3e2a5eaae", "fc323ffcaeaed0e0a02bf4d117757b98aed530d9ed4531e3e15460124c106691"] | |
| 350 | 582 | colorama = ["05eed71e2e327246ad6b38c540c4a3117230b19679b875190486ddd2d721422d", "f8ac84de7840f5b9c4e3347b3c1eaa50f7e49c2b07596221daec5edaabbd7c48"] |
| 351 | 583 | coverage = ["08907593569fe59baca0bf152c43f3863201efb6113ecb38ce7e97ce339805a6", "0be0f1ed45fc0c185cfd4ecc19a1d6532d72f86a2bac9de7e24541febad72650", "141f08ed3c4b1847015e2cd62ec06d35e67a3ac185c26f7635f4406b90afa9c5", "19e4df788a0581238e9390c85a7a09af39c7b539b29f25c89209e6c3e371270d", "23cc09ed395b03424d1ae30dcc292615c1372bfba7141eb85e11e50efaa6b351", "245388cda02af78276b479f299bbf3783ef0a6a6273037d7c60dc73b8d8d7755", "331cb5115673a20fb131dadd22f5bcaf7677ef758741312bee4937d71a14b2ef", "386e2e4090f0bc5df274e720105c342263423e77ee8826002dcffe0c9533dbca", "3a794ce50daee01c74a494919d5ebdc23d58873747fa0e288318728533a3e1ca", "60851187677b24c6085248f0a0b9b98d49cba7ecc7ec60ba6b9d2e5574ac1ee9", "63a9a5fc43b58735f65ed63d2cf43508f462dc49857da70b8980ad78d41d52fc", "6b62544bb68106e3f00b21c8930e83e584fdca005d4fffd29bb39fb3ffa03cb5", "6ba744056423ef8d450cf627289166da65903885272055fb4b5e113137cfa14f", "7494b0b0274c5072bddbfd5b4a6c6f18fbbe1ab1d22a41e99cd2d00c8f96ecfe", "826f32b9547c8091679ff292a82aca9c7b9650f9fda3e2ca6bf2ac905b7ce888", "93715dffbcd0678057f947f496484e906bf9509f5c1c38fc9ba3922893cda5f5", "9a334d6c83dfeadae576b4d633a71620d40d1c379129d587faa42ee3e2a85cce", "af7ed8a8aa6957aac47b4268631fa1df984643f07ef00acd374e456364b373f5", "bf0a7aed7f5521c7ca67febd57db473af4762b9622254291fbcbb8cd0ba5e33e", "bf1ef9eb901113a9805287e090452c05547578eaab1b62e4ad456fcc049a9b7e", "c0afd27bc0e307a1ffc04ca5ec010a290e49e3afbe841c5cafc5c5a80ecd81c9", "dd579709a87092c6dbee09d1b7cfa81831040705ffa12a1b248935274aee0437", "df6712284b2e44a065097846488f66840445eb987eb81b3cc6e4149e7b6982e1", "e07d9f1a23e9e93ab5c62902833bf3e4b1f65502927379148b6622686223125c", "e2ede7c1d45e65e209d6093b762e98e8318ddeff95317d07a27a2140b80cfd24", "e4ef9c164eb55123c62411f5936b5c2e521b12356037b6e1c2617cef45523d47", "eca2b7343524e7ba246cab8ff00cab47a2d6d54ada3b02772e908a45675722e2", "eee64c616adeff7db37cc37da4180a3a5b6177f5c46b187894e633f088fb5b28", "ef824cad1f980d27f26166f86856efe11eff9912c4fed97d3804820d43fa550c", "efc89291bd5a08855829a3c522df16d856455297cf35ae827a37edac45f466a7", "fa964bae817babece5aa2e8c1af841bebb6d0b9add8e637548809d040443fee0", "ff37757e068ae606659c28c3bd0d923f9d29a85de79bf25b2b34b148473b5025"] |
| 352 | 584 | docutils = ["02aec4bd92ab067f6ff27a38a38a41173bf01bed8f89157768c1573f53e474a6", "51e64ef2ebfb29cae1faa133b3710143496eca21c530f3f71424d77687764274", "7a4bd47eaf6596e1295ecb11361139febe29b084a87bf005bf899f9a42edc3c6"] |
| @@ -355,8 +587,12 @@ | ||
| 355 | 587 | flake8-docstrings = ["3ad372b641f4c8e70c7465f067aed4ff8bf1e9347fce14f9eb71ed816db36257", "d8d72ccd5807c1ab9ff1466cb9bece0c4d94b8669e9bc4f472abc80dbc5d399e"] |
| 356 | 588 | flake8-isort = ["1e67b6b90a9b980ac3ff73782087752d406ce0a729ed928b92797f9fa188917e", "81a8495eefed3f2f63f26cd2d766c7b1191e923a15b9106e6233724056572c68"] |
| 357 | 589 | flake8-polyfill = ["12be6a34ee3ab795b19ca73505e7b55826d5f6ad7230d31b18e106400169b9e9", "e44b087597f6da52ec6393a709e7108b2905317d0c0b744cdca6208e670d8eda"] |
| 590 | +idna = ["c357b3f628cf53ae2c4c05627ecc484553142ca23264e593d327bcde5e9c3407", "ea8b7f6188e6fa117537c3df7da9fc686d485087abf6ac197f9c46432f7e4a3c"] | |
| 591 | +imagesize = ["3f349de3eb99145973fefb7dbe38554414e5c30abd0c8e4b970a7c9d09f3a1d8", "f3832918bc3c66617f92e35f5d70729187676313caa60c187eb0f28b8fe5e3b5"] | |
| 358 | 592 | importlib-metadata = ["23d3d873e008a513952355379d93cbcab874c58f4f034ff657c7a87422fa64e8", "80d2de76188eabfbfcf27e6a37342c2827801e59c4cc14b0371c56fed43820e3"] |
| 359 | 593 | isort = ["54da7e92468955c4fceacd0c86bd0ec997b0e1ee80d97f67c35a78b719dccab1", "6e811fcb295968434526407adb8796944f1988c5b65e8139058f2014cbe100fd"] |
| 594 | +jinja2 = ["065c4f02ebe7f7cf559e49ee5a95fb800a9e4528727aec6f24402a5374c65013", "14dd6caf1527abb21f08f86c784eac40853ba93edb79552aa1e4b8aef1b61c7b"] | |
| 595 | +markupsafe = ["00bc623926325b26bb9605ae9eae8a215691f33cae5df11ca5424f06f2d1f473", "09027a7803a62ca78792ad89403b1b7a73a01c8cb65909cd876f7fcebd79b161", "09c4b7f37d6c648cb13f9230d847adf22f8171b1ccc4d5682398e77f40309235", "1027c282dad077d0bae18be6794e6b6b8c91d58ed8a8d89a89d59693b9131db5", "24982cc2533820871eba85ba648cd53d8623687ff11cbb805be4ff7b4c971aff", "29872e92839765e546828bb7754a68c418d927cd064fd4708fab9fe9c8bb116b", "43a55c2930bbc139570ac2452adf3d70cdbb3cfe5912c71cdce1c2c6bbd9c5d1", "46c99d2de99945ec5cb54f23c8cd5689f6d7177305ebff350a58ce5f8de1669e", "500d4957e52ddc3351cabf489e79c91c17f6e0899158447047588650b5e69183", "535f6fc4d397c1563d08b88e485c3496cf5784e927af890fb3c3aac7f933ec66", "62fe6c95e3ec8a7fad637b7f3d372c15ec1caa01ab47926cfdf7a75b40e0eac1", "6dd73240d2af64df90aa7c4e7481e23825ea70af4b4922f8ede5b9e35f78a3b1", "717ba8fe3ae9cc0006d7c451f0bb265ee07739daf76355d06366154ee68d221e", "79855e1c5b8da654cf486b830bd42c06e8780cea587384cf6545b7d9ac013a0b", "7c1699dfe0cf8ff607dbdcc1e9b9af1755371f92a68f706051cc8c37d447c905", "88e5fcfb52ee7b911e8bb6d6aa2fd21fbecc674eadd44118a9cc3863f938e735", "8defac2f2ccd6805ebf65f5eeb132adcf2ab57aa11fdf4c0dd5169a004710e7d", "98c7086708b163d425c67c7a91bad6e466bb99d797aa64f965e9d25c12111a5e", "9add70b36c5666a2ed02b43b335fe19002ee5235efd4b8a89bfcf9005bebac0d", "9bf40443012702a1d2070043cb6291650a0841ece432556f784f004937f0f32c", "ade5e387d2ad0d7ebf59146cc00c8044acbd863725f887353a10df825fc8ae21", "b00c1de48212e4cc9603895652c5c410df699856a2853135b3967591e4beebc2", "b1282f8c00509d99fef04d8ba936b156d419be841854fe901d8ae224c59f0be5", "b2051432115498d3562c084a49bba65d97cf251f5a331c64a12ee7e04dacc51b", "ba59edeaa2fc6114428f1637ffff42da1e311e29382d81b339c1817d37ec93c6", "c8716a48d94b06bb3b2524c2b77e055fb313aeb4ea620c8dd03a105574ba704f", "cd5df75523866410809ca100dc9681e301e3c27567cf498077e8551b6d20e42f", "e249096428b3ae81b08327a63a485ad0878de3fb939049038579ac0ef61e17e7"] | |
| 360 | 596 | mccabe = ["ab8a6258860da4b6677da4bd2fe5dc2c659cff31b3ee4f7f5d64e79735b80d42", "dd8d182285a0fe56bace7f45b5e7d1a6ebcbf524e8f3bd87eb0f125271b8831f"] |
| 361 | 597 | more-itertools = ["409cd48d4db7052af495b09dec721011634af3753ae1ef92d2b32f73a745f832", "92b8c4b06dac4f0611c0729b2f2ede52b2e1bac1ab48f089c7ddc12e26bb60c4"] |
| 362 | 598 | packaging = ["a7ac867b97fdc07ee80a8058fe4435ccd274ecc3b0ed61d852d7d53055528cf9", "c491ca87294da7cc01902edbe30a5bc6c4c28172b5138ab4e4aa1b9d7bfaeafe"] |
| @@ -367,11 +603,23 @@ | ||
| 367 | 603 | pydocstyle = ["04c84e034ebb56eb6396c820442b8c4499ac5eb94a3bda88951ac3dc519b6058", "66aff87ffe34b1e49bff2dd03a88ce6843be2f3346b0c9814410d34987fbab59"] |
| 368 | 604 | pyflakes = ["17dbeb2e3f4d772725c777fabc446d5634d1038f234e77343108ce445ea69ce0", "d976835886f8c5b31d47970ed689944a0262b5f3afa00a5a7b4dc81e5449f8a2"] |
| 369 | 605 | pygenstub = ["4f4b5a42fae84857f83a67b2f9f06068b0dc1fea2fc234c886c63e2c07738bf7", "a47a46354a05de7608d98cf7752ba170bf5b24e7911cc7653e298cc0fb8803a3"] |
| 606 | +pygments = ["71e430bc85c88a430f000ac1d9b331d2407f681d6f6aec95e8bcfbc3df5b0127", "881c4c157e45f30af185c1ffe8d549d48ac9127433f2c380c24b84572ad66297"] | |
| 370 | 607 | pyparsing = ["6f98a7b9397e206d78cc01df10131398f1c8b8510a2f4d97d9abd82e1aacdd80", "d9338df12903bbf5d65a0e4e87c2161968b10d2e489652bb47001d82a9b028b4"] |
| 371 | 608 | pytest = ["95b1f6db806e5b1b5b443efeb58984c24945508f93a866c1719e1a507a957d7c", "c3d5020755f70c82eceda3feaf556af9a341334414a8eca521a18f463bcead88"] |
| 372 | 609 | pytest-cov = ["2b097cde81a302e1047331b48cadacf23577e431b61e9c6f49a1170bbe3d3da6", "e00ea4fdde970725482f1f35630d12f074e121a23801aabf2ae154ec6bdd343a"] |
| 610 | +pytz = ["26c0b32e437e54a18161324a2fca3c4b9846b74a8dccddd843113109e1116b32", "c894d57500a4cd2d5c71114aaab77dbab5eabd9022308ce5ac9bb93a60a6f0c7"] | |
| 611 | +requests = ["11e007a8a2aa0323f5a921e9e6a2d7e4e67d9877e85773fba9ba6419025cbeb4", "9cf5292fcd0f598c671cfc1e0d7d1a7f13bb8085e9a590f48c010551dc6c4b31"] | |
| 373 | 612 | six = ["3350809f0555b11f552448330d0b52d5f24c91a322ea4a15ef22629740f3761c", "d16a0141ec1a18405cd4ce8b4613101da75da0e9a7aec5bdd4fa804d0e0eba73"] |
| 374 | 613 | snowballstemmer = ["9f3b9ffe0809d174f7047e121431acf99c89a7040f0ca84f94ba53a498e6d0c9"] |
| 614 | +sphinx = ["0d586b0f8c2fc3cc6559c5e8fd6124628110514fda0e5d7c82e682d749d2e845", "839a3ed6f6b092bb60f492024489cc9e6991360fb9f52ed6361acd510d261069"] | |
| 615 | +sphinx-rtd-theme = ["00cf895504a7895ee433807c62094cf1e95f065843bf3acd17037c3e9a2becd4", "728607e34d60456d736cc7991fd236afb828b21b82f956c5ea75f94c8414040a"] | |
| 616 | +sphinxcontrib-applehelp = ["edaa0ab2b2bc74403149cb0209d6775c96de797dfd5b5e2a71981309efab3897", "fb8dee85af95e5c30c91f10e7eb3c8967308518e0f7488a2828ef7bc191d0d5d"] | |
| 617 | +sphinxcontrib-devhelp = ["6c64b077937330a9128a4da74586e8c2130262f014689b4b89e2d08ee7294a34", "9512ecb00a2b0821a146736b39f7aeb90759834b07e81e8cc23a9c70bacb9981"] | |
| 618 | +sphinxcontrib-htmlhelp = ["4670f99f8951bd78cd4ad2ab962f798f5618b17675c35c5ac3b2132a14ea8422", "d4fd39a65a625c9df86d7fa8a2d9f3cd8299a3a4b15db63b50aac9e161d8eff7"] | |
| 619 | +sphinxcontrib-jsmath = ["2ec2eaebfb78f3f2078e73666b1415417a116cc848b72e5172e596c871103178", "a9925e4a4587247ed2191a22df5f6970656cb8ca2bd6284309578f2153e0c4b8"] | |
| 620 | +sphinxcontrib-qthelp = ["513049b93031beb1f57d4daea74068a4feb77aa5630f856fcff2e50de14e9a20", "79465ce11ae5694ff165becda529a600c754f4bc459778778c7017374d4d406f"] | |
| 621 | +sphinxcontrib-serializinghtml = ["c0efb33f8052c04fd7a26c0a07f1678e8512e0faec19f4aa8f2473a8b81d5227", "db6615af393650bf1151a6cd39120c29abaf93cc60db8c48eb2dddbfdc3a9768"] | |
| 375 | 622 | testfixtures = ["665a298976c8d77f311b65c46f16b7cda7229a47dff5ad7c822e5b3371a439e2", "9d230c5c80746f9f86a16a1f751a5cf5d8e317d4cc48243a19fb180d22303bce"] |
| 623 | +urllib3 = ["b246607a25ac80bedac05c6f282e3cdaf3afb65420fd024ac94435cabe6e18d1", "dbe59173209418ae49d485b87d1681aefa36252ee85884c31346debd19463232"] | |
| 376 | 624 | wcwidth = ["3df37372226d6e63e1b1e1eda15c594bca98a22d33a23832a90998faa96bc65e", "f4ebe71925af7b40a864553f761ed559b43544f8f71746c2d756c7fe788ade7c"] |
| 377 | 625 | zipp = ["3718b1cbcd963c7d4c5511a8240812904164b7f381b647143a89d3b98f9bcd8e", "f06903e9f1f43b12d371004b4ac7b06ab39a44adc747266928ae6debfa7b3335"] |
| @@ -36,6 +36,8 @@ | ||
| 36 | 36 | flake8 = "^3.7.8" |
| 37 | 37 | flake8-isort = "^2.7.0" |
| 38 | 38 | flake8-docstrings = "^1.3.1" |
| 39 | +sphinx = "^2.2.0" | |
| 40 | +sphinx_rtd_theme = "^0.4.3" | |
| 39 | 41 | pygenstub = "^1.4.0" |
| 40 | 42 | |
| 41 | 43 | [tool.black] |
| @@ -44,7 +46,7 @@ | ||
| 44 | 46 | [tool.tox] |
| 45 | 47 | legacy_tox_ini = """ |
| 46 | 48 | [tox] |
| 47 | -envlist = py{37,36,35}, style | |
| 49 | +envlist = py{37,36,35}, style, docs | |
| 48 | 50 | isolated_build = True |
| 49 | 51 | |
| 50 | 52 | [testenv] |
| @@ -62,6 +64,12 @@ | ||
| 62 | 64 | commands = |
| 63 | 65 | poetry install -v |
| 64 | 66 | {posargs:flake8} humphrey |
| 67 | + | |
| 68 | +[testenv:docs] | |
| 69 | +changedir = docs/ | |
| 70 | +commands = | |
| 71 | + poetry install -v | |
| 72 | + sphinx-build -b html source/ build/html/ | |
| 65 | 73 | """ |
| 66 | 74 | |
| 67 | 75 | [build-system] |
Fork