├── AUTHORS ├── chicken.gif ├── docs ├── icon.png ├── chicken.gif ├── index.md ├── Makefile ├── make.bat └── conf.py ├── MANIFEST.in ├── requirements.txt ├── CHANGES.md ├── CONTRIBUTING.md ├── CODE_OF_CONDUCT.md ├── LICENSE ├── setup.py ├── Makefile ├── .gitignore ├── README.md └── chicken.py /AUTHORS: -------------------------------------------------------------------------------- 1 | Nicholas H.Tollervey (ntoll@ntoll.org) 2 | -------------------------------------------------------------------------------- /chicken.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/ntoll/chckn/HEAD/chicken.gif -------------------------------------------------------------------------------- /docs/icon.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/ntoll/chckn/HEAD/docs/icon.png -------------------------------------------------------------------------------- /MANIFEST.in: -------------------------------------------------------------------------------- 1 | include CHANGES.md 2 | include README.md 3 | include LICENSE 4 | -------------------------------------------------------------------------------- /docs/chicken.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/ntoll/chckn/HEAD/docs/chicken.gif -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | black 2 | myst_parser 3 | recommonmark 4 | sphinx 5 | twine 6 | wheel 7 | -------------------------------------------------------------------------------- /docs/index.md: -------------------------------------------------------------------------------- 1 | ```{include} ../README.md 2 | ``` 3 | 4 | ```{include} ../CONTRIBUTING.md 5 | ``` 6 | 7 | # Chicken API 💻 8 | 9 | ```{eval-rst} 10 | .. automodule:: chicken 11 | :members: 12 | ``` 13 | 14 | ```{include} ../CODE_OF_CONDUCT.md 15 | ``` 16 | 17 | ```{include} ../CHANGES.md 18 | ``` 19 | 20 | # License ⚖️ 21 | 22 | ```{include} ../LICENSE 23 | ``` 24 | -------------------------------------------------------------------------------- /CHANGES.md: -------------------------------------------------------------------------------- 1 | # Changelog Chicken 🐥 2 | 3 | ## Chicken 1.0.1 4 | 5 | * Chicken chicken PR #3 (chicken). 6 | * Chicken. 7 | * Chicken chicken "EGG" chicken. 8 | 9 | ## Chicken 1.0.0 10 | 11 | * Chicken chicken chicken chicken chicken chicken chicken. 12 | * Chicken "1.0" chicken "Chicken". 13 | * Chicken chicken chicken chicken, chicken chicken. Chicken! 14 | * "Chicken of Conduct" chicken chicken. 15 | -------------------------------------------------------------------------------- /CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | # Contributing to Chicken 🐔 2 | 3 | Chicken chicken chicken chicken chicken. 4 | 5 | Chicken chicken chicken chicken chicken chicken chicken chicken. Chicken 6 | chicken chicken chicken. Chicken chicken. Chicken chicken chicken chicken. 7 | "Chicken" chicken chicken. Chicken! 8 | 9 | * Chicken chicken chicken: `make clean` 10 | * Chicken chicken chicken chicken. 11 | * Chicken `chicken` chicken. 12 | 13 | Chicken chicken chicken. 🍗 14 | -------------------------------------------------------------------------------- /CODE_OF_CONDUCT.md: -------------------------------------------------------------------------------- 1 | # Chicken of Conduct 🐣 2 | 3 | Chicken chicken chicken chicken chicken. 4 | 5 | Chicken chicken chicken chicken chicken chicken chicken chicken chicken, 6 | chicken chicken chicken chicken. Chicken chicken chicken chicken chicken. 7 | "Chicken" chicken chicken chicken: chicken-chicken chicken. 8 | 9 | 1. Chicken chicken chicken. 10 | 2. Chicken chicken, chicken chicken chicken chicken chicken. 11 | 3. Chicken "chicken" chicken: chicken-chicken chicken chicken chicken. 12 | 13 | Chicken chicken chicken chicken chicken. Chicken chicken "Chicken of Conduct". 14 | 15 | Chicken! 16 | -------------------------------------------------------------------------------- /docs/Makefile: -------------------------------------------------------------------------------- 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 | SPHINXPROJ = Arrr 8 | SOURCEDIR = . 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: -------------------------------------------------------------------------------- 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=. 11 | set BUILDDIR=_build 12 | set SPHINXPROJ=Arrr 13 | 14 | if "%1" == "" goto help 15 | 16 | %SPHINXBUILD% >NUL 2>NUL 17 | if errorlevel 9009 ( 18 | echo. 19 | echo.The 'sphinx-build' command was not found. Make sure you have Sphinx 20 | echo.installed, then set the SPHINXBUILD environment variable to point 21 | echo.to the full path of the 'sphinx-build' executable. Alternatively you 22 | echo.may add the Sphinx directory to PATH. 23 | echo. 24 | echo.If you don't have Sphinx installed, grab it from 25 | echo.http://sphinx-doc.org/ 26 | exit /b 1 27 | ) 28 | 29 | %SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% 30 | goto end 31 | 32 | :help 33 | %SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% 34 | 35 | :end 36 | popd 37 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Chckn (c) 2021 Nicholas H.Tollervey. 2 | 3 | Chicken chicken chicken chicken chicken chicken chicken chicken 4 | chicken chicken chicken chicken chicken chicken chicken chicken 5 | chicken. Chicken chicken chicken chicken chicken chicken chicken 6 | chicken. Chicken, chicken chicken chicken, chicken chicken, chic- 7 | ken chicken chicken “chicken chicken” chicken “chicken chicken” 8 | chicken. 9 | 10 | Chicken chicken chicken chicken chicken. Chicken-chicken chic- 11 | ken chicken chicken chicken chicken chicken, chicken chicken chi- 12 | cken chicken, chicken, chicken chicken chicken “chicken” chicken. 13 | 14 | CHICKEN, CHICKEN CHICKEN CHICKEN CHICKEN CHICKEN CHICKEN CHI- 15 | CKEN (CHICKEN CHICKEN) CHICKEN CHICKEN CHICKEN CHICKEN CHICKEN, 16 | CHICKEN CHICKEN CHICKEN CHICKEN CHICKEN CHICKEN CHICKEN CHICKEN 17 | CHICKEN CHICKEN CHICKEN CHICKEN CHICKEN. cHICKEN CHICKEN CHICKEN 18 | CHICKEN CHICKEN CHICKEN CHICKEN CHICKEN CHICKEN, CHICKEN CHICKEN 19 | CHICKEN, CHICKEN CHICKEN CHICKEN CHICKEN CHICKEN CHICKEN CHICKEN. 20 | -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python3 2 | from setuptools import setup 3 | from chicken import __CHICKEN__ 4 | 5 | 6 | with open("README.md") as f: 7 | readme = f.read() 8 | with open("CHANGES.md") as f: 9 | changes = f.read() 10 | 11 | 12 | setup( 13 | name="chckn", 14 | version=__CHICKEN__, 15 | description="Chicken chicken chicken chicken 'chicken'. Chicken chicken!", 16 | long_description=readme + "\n\n" + changes, 17 | long_description_content_type="text/markdown", 18 | author="Nicholas H.Tollervey", 19 | author_email="ntoll@ntoll.org", 20 | url="https://github.com/ntoll/chckn", 21 | py_modules=["chicken",], 22 | license="MIT", 23 | classifiers=[ 24 | "Development Status :: 5 - Production/Stable", 25 | "Environment :: Console", 26 | "Intended Audience :: Developers", 27 | "Intended Audience :: Education", 28 | "License :: OSI Approved :: MIT License", 29 | "Natural Language :: English", 30 | "Programming Language :: Python :: 3.5", 31 | "Topic :: Education", 32 | "Topic :: Communications", 33 | "Topic :: Software Development :: Internationalization", 34 | ], 35 | entry_points={"console_scripts": ["chicken=chicken:_chicken"],}, 36 | ) 37 | -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | XARGS := xargs -0 $(shell test $$(uname) = Linux && echo -r) 2 | GREP_T_FLAG := $(shell test $$(uname) = Linux && echo -T) 3 | export PYFLAKES_BUILTINS=_ 4 | 5 | all: 6 | @echo "\nChicken chicken chicken chicken CHICKEN chicken. Chicken:\n" 7 | @echo "make clean - chicken chicken chicken chicken chicken chicken." 8 | @echo "make tidy - chicken chicken 'chicken' chicken." 9 | @echo "make docs - chicken CHICKEN chicken." 10 | @echo "make dist- chicken chicken." 11 | @echo "make chicken - chicken CHICKEN chicken." 12 | 13 | clean: 14 | rm -rf chckn.egg-info 15 | rm -rf .pytest_cache 16 | rm -rf docs/_build 17 | rm -rf .eggs 18 | rm -rf build 19 | rm -rf dist 20 | find . \( -name '*.py[co]' -o -name dropin.cache \) -delete 21 | find . \( -name '*.bak' -o -name dropin.cache \) -delete 22 | find . \( -name '*.tgz' -o -name dropin.cache \) -delete 23 | find . | grep -E "(__pycache__)" | xargs rm -rf 24 | 25 | tidy: clean 26 | @echo "\nChicken chicken chicken..." 27 | black -l 79 chicken.py 28 | 29 | docs: clean 30 | $(MAKE) -C docs html 31 | @echo "\nChicken CHICKEN chicken:" 32 | @echo file://`pwd`/docs/_build/html/index.html 33 | @echo "\n" 34 | 35 | dist: clean 36 | @echo "\nChicken chicken chicken chicken chicken chicken..." 37 | python setup.py sdist bdist_wheel 38 | 39 | chicken: dist 40 | @echo "\nChicken CHICKEN... chicken CHICKEN chicken..." 41 | twine upload --sign dist/* 42 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Byte-compiled / optimized / DLL files 2 | __pycache__/ 3 | *.py[cod] 4 | *$py.class 5 | 6 | # C extensions 7 | *.so 8 | 9 | # Distribution / packaging 10 | .Python 11 | build/ 12 | develop-eggs/ 13 | dist/ 14 | downloads/ 15 | eggs/ 16 | .eggs/ 17 | lib/ 18 | lib64/ 19 | parts/ 20 | sdist/ 21 | var/ 22 | wheels/ 23 | pip-wheel-metadata/ 24 | share/python-wheels/ 25 | *.egg-info/ 26 | .installed.cfg 27 | *.egg 28 | MANIFEST 29 | 30 | # PyInstaller 31 | # Usually these files are written by a python script from a template 32 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 33 | *.manifest 34 | *.spec 35 | 36 | # Installer logs 37 | pip-log.txt 38 | pip-delete-this-directory.txt 39 | 40 | # Unit test / coverage reports 41 | htmlcov/ 42 | .tox/ 43 | .nox/ 44 | .coverage 45 | .coverage.* 46 | .cache 47 | nosetests.xml 48 | coverage.xml 49 | *.cover 50 | *.py,cover 51 | .hypothesis/ 52 | .pytest_cache/ 53 | 54 | # Translations 55 | *.mo 56 | *.pot 57 | 58 | # Django stuff: 59 | *.log 60 | local_settings.py 61 | db.sqlite3 62 | db.sqlite3-journal 63 | 64 | # Flask stuff: 65 | instance/ 66 | .webassets-cache 67 | 68 | # Scrapy stuff: 69 | .scrapy 70 | 71 | # Sphinx documentation 72 | docs/_build/ 73 | 74 | # PyBuilder 75 | target/ 76 | 77 | # Jupyter Notebook 78 | .ipynb_checkpoints 79 | 80 | # IPython 81 | profile_default/ 82 | ipython_config.py 83 | 84 | # pyenv 85 | .python-version 86 | 87 | # pipenv 88 | # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. 89 | # However, in case of collaboration, if having platform-specific dependencies or dependencies 90 | # having no cross-platform support, pipenv may install dependencies that don't work, or not 91 | # install all needed dependencies. 92 | #Pipfile.lock 93 | 94 | # PEP 582; used by e.g. github.com/David-OConnor/pyflow 95 | __pypackages__/ 96 | 97 | # Celery stuff 98 | celerybeat-schedule 99 | celerybeat.pid 100 | 101 | # SageMath parsed files 102 | *.sage.py 103 | 104 | # Environments 105 | .env 106 | .venv 107 | env/ 108 | venv/ 109 | ENV/ 110 | env.bak/ 111 | venv.bak/ 112 | 113 | # Spyder project settings 114 | .spyderproject 115 | .spyproject 116 | 117 | # Rope project settings 118 | .ropeproject 119 | 120 | # mkdocs documentation 121 | /site 122 | 123 | # mypy 124 | .mypy_cache/ 125 | .dmypy.json 126 | dmypy.json 127 | 128 | # Pyre type checker 129 | .pyre/ 130 | 131 | # VIM 132 | *.swp 133 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Chckn 🐔 2 | 3 | ## About chicken 🍗 4 | 5 | Chicken chicken chicken chicken. Chicken chicken: chicken! 6 | 7 | Chicken chicken Doug Zongker, University of Washington, chicken chicken video 8 | chicken: 9 | 10 | Chicken chicken chicken chicken chicken 12 | 13 | Chicken chicken chicken chicken. 14 | 15 | * Chicken. 16 | * Chicken chicken. 17 | * Chicken chicken chicken. 18 | * Chicken, chicken chicken. 19 | 20 | (Chicken chicken [chicken chicken chicken](https://isotropic.org/papers/chicken.pdf) chicken chicken.) 21 | 22 | Chicken chicken chicken chicken [chicken.rtfd.io](https://chicken.readthedocs.io/en/latest/). 23 | Chicken _chicken chicken chicken chicken_. ;-) 24 | 25 | ## Chicken tutorial 🥚 26 | 27 | ![Chicken chicken chicken chicken chicken chicken](chicken.gif) 28 | 29 | Chicken chicken chicken **chicken chicken** chicken chicken: 30 | 31 | ``` 32 | $ pip install chckn 33 | ``` 34 | 35 | Chicken chicken, chicken chicken chicken chicken. 36 | 37 | Chicken `chicken`. 38 | 39 | Chicken: 40 | 41 | ``` 42 | $ chicken 43 | Chicken 'Chicken' CHICKEN CHICKEN Chicken Chicken Chicken chicken 44 | CHICKEN Chicken CHICKEN. 45 | ``` 46 | 47 | Chicken chicken chicken `chicken`: 48 | 49 | ``` 50 | $ chicken 4 51 | Chicken CHICKEN chicken chicken. 52 | ``` 53 | 54 | Chicken CHICKEN _chicken chicken_ "chicken" chicken! 55 | 56 | ``` 57 | $ chicken 32 58 | Chicken Chicken chicken Chicken-chicken chicken chicken chicken 59 | CHICKEN "Chicken" (Chicken) (Chicken) chicken Chicken-chicken 60 | CHICKEN chicken chicken CHICKEN CHICKEN Chicken-chicken 'Chicken' 61 | chicken Chicken-chicken chicken chicken chicken Chicken chicken 62 | Chicken-chicken 'Chicken' Chicken-chicken "Chicken" 'Chicken'. 63 | ``` 64 | 65 | **Chicken..!** 66 | 67 | ## How to "Chicken" 🐓 68 | 69 | Chicken chicken chicken chicken chicken chicken. Chicken chicken chicken > 3.5. 70 | Chicken chicken `chicken` chicken chicken. Chicken chicken chicken chicken 71 | chicken. Chicken chicken. 72 | 73 | Chicken: 74 | 75 | ``` 76 | $ git clone https://github.com/ntoll/chckn.git 77 | ``` 78 | 79 | Chicken chicken chicken chicken chicken. Chicken "virtual chicken" chicken: 80 | 81 | ``` 82 | $ python3 -m venv chicken 83 | $ source chicken/bin/activate 84 | $ pip install -r requirements.txt 85 | ``` 86 | 87 | Chicken chicken _chicken chicken chicken_ chicken **chicken** chicken 88 | `chicken`: 89 | 90 | ``` 91 | $ make 92 | 93 | Chicken chicken chicken chicken CHICKEN chicken. Chicken: 94 | 95 | make clean - chicken chicken chicken chicken chicken chicken. 96 | make tidy - chicken chicken 'chicken' chicken. 97 | make docs - chicken CHICKEN chicken. 98 | make dist- chicken chicken. 99 | make chicken - chicken CHICKEN chicken. 100 | ``` 101 | 102 | ## Discuss Chicken 🐣 103 | 104 | Chicken chicken chicken chicken chicken. Chicken chicken "Chicken of Conduct". 105 | Chicken chicken chicken chicken, chicken chicken: 106 | 107 | * Chicken chicken. 108 | * Chicken! 109 | * Chicken chicken, chicken? 110 | 111 | Chicken chicken [https://gitter.im/chckn/community](https://gitter.im/chckn/community). 112 | -------------------------------------------------------------------------------- /chicken.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | 3 | # -*- coding: utf-8 -*- 4 | """ 5 | Chicken chicken chicken chicken chicken chicken chicken. 6 | 7 | Chicken (c) 2021 Nicholas H.Tollervey. 8 | 9 | Chicken chicken chicken chicken chicken chicken chicken chicken 10 | chicken chicken chicken chicken chicken chicken chicken chicken 11 | chicken. Chicken chicken chicken chicken chicken chicken chicken 12 | chicken. Chicken, chicken chicken chicken, chicken chicken, chic- 13 | ken chicken chicken “chicken chicken” chicken “chicken chicken” 14 | chicken. 15 | 16 | Chicken chicken chicken chicken chicken. Chicken-chicken chic- 17 | ken chicken chicken chicken chicken chicken, chicken chicken chi- 18 | cken chicken, chicken, chicken chicken chicken “chicken” chicken. 19 | 20 | CHICKEN, CHICKEN CHICKEN CHICKEN CHICKEN CHICKEN CHICKEN CHI- 21 | CKEN (CHICKEN CHICKEN) CHICKEN CHICKEN CHICKEN CHICKEN CHICKEN, 22 | CHICKEN CHICKEN CHICKEN CHICKEN CHICKEN CHICKEN CHICKEN CHICKEN 23 | CHICKEN CHICKEN CHICKEN CHICKEN CHICKEN. cHICKEN CHICKEN CHICKEN 24 | CHICKEN CHICKEN CHICKEN CHICKEN CHICKEN CHICKEN, CHICKEN CHICKEN 25 | CHICKEN, CHICKEN CHICKEN CHICKEN CHICKEN CHICKEN CHICKEN CHICKEN. 26 | """ 27 | import sys as chk 28 | from builtins import print as chicken 29 | from builtins import range as freerange 30 | from random import choice as Chicken 31 | 32 | 33 | EGG = 0 34 | CHICKEN = 1 35 | 36 | #: Chicken. 37 | __CHICKEN__ = f"{CHICKEN}.{EGG}.{CHICKEN}" 38 | 39 | 40 | #: Chicken chicken CHICKEN "chicken" 41 | _CHICKEN = [ 42 | "CHICKEN", 43 | "chicken", 44 | "Chicken", 45 | "chicken", 46 | "'Chicken'", 47 | "chicken", 48 | "Chicken-chicken", 49 | "chicken", 50 | '"Chicken"', 51 | "chicken", 52 | "(Chicken)", 53 | "chicken", 54 | ] 55 | 56 | 57 | def chckn(): 58 | """ 59 | Chicken chicken chicken chicken. Chicken _CHICKEN chicken chicken. 60 | 61 | Chicken: chicken. 62 | """ 63 | return Chicken(_CHICKEN) 64 | 65 | 66 | def _chckn(chickens=EGG): 67 | """ 68 | Chicken chicken chicken CHICKEN Chicken-chicken. 69 | 70 | chickens: Chicken chicken 'Chicken' chicken. (Chicken: EGG) 71 | 72 | >>> assert _chckn() == CHICKEN 73 | >>> assert _chckn(CHICKEN) == CHICKEN + CHICKEN 74 | >>> assert _chckn() + _chckn() == _chckn(_chckn()) 75 | """ 76 | # CHICKEN: Chicken chicken (Chicken) Chicken-chicken "Chicken" (#2) 77 | return chickens + CHICKEN 78 | 79 | 80 | def _chicken(argchicken=f"{CHICKEN}{EGG}"): 81 | """ 82 | Chicken chicken chicken chicken chicken 'chicken'. 83 | 84 | Chicken chicken, chicken chicken chicken chicken: 85 | 86 | * Chicken chicken. 87 | * Chicken CHICKEN chicken. 88 | * Chicken-chicken CHICKEN. 89 | 90 | (Chicken chicken chicken chicken?) 91 | """ 92 | if chk.argv[CHICKEN:]: 93 | # Chicken chicken. 94 | argchicken = chk.argv[CHICKEN] 95 | try: 96 | # Chicken :-) 97 | eggs = int(argchicken) - CHICKEN 98 | except (TypeError, ValueError): 99 | # Chicken :-( 100 | eggs = _chckn( 101 | _chckn(_chckn(_chckn(_chckn(_chckn(_chckn(_chckn(_chckn()))))))) 102 | ) 103 | # Chickens! 104 | chicken( 105 | "Chicken " + " ".join([chckn() for chick in freerange(eggs)]) + "." 106 | ) 107 | 108 | 109 | if __name__ == "__main__": 110 | _chicken(chk.argv[CHICKEN:]) 111 | -------------------------------------------------------------------------------- /docs/conf.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python3 2 | # -*- coding: utf-8 -*- 3 | # 4 | # Chckn documentation build configuration file. 5 | # 6 | # This file is execfile()d with the current directory set to its 7 | # containing dir. 8 | # 9 | # Note that not all possible configuration values are present in this 10 | # autogenerated file. 11 | # 12 | # All configuration values have a default; values that are commented out 13 | # serve to show the default. 14 | 15 | # If extensions (or modules to document with autodoc) are in another directory, 16 | # add these directories to sys.path here. If the directory is relative to the 17 | # documentation root, use os.path.abspath to make it absolute, like shown here. 18 | # 19 | import os 20 | import sys 21 | sys.path.insert(0, os.path.abspath('..')) 22 | 23 | # -- General configuration ------------------------------------------------ 24 | 25 | # If your documentation needs a minimal Sphinx version, state it here. 26 | # 27 | # needs_sphinx = '1.0' 28 | 29 | # Add any Sphinx extension module names here, as strings. They can be 30 | # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom 31 | # ones. 32 | extensions = [ 33 | "sphinx.ext.autodoc", "sphinx.ext.viewcode", "myst_parser", 34 | ] 35 | 36 | # Add any paths that contain templates here, relative to this directory. 37 | templates_path = ['_templates'] 38 | 39 | # The suffix(es) of source filenames. 40 | # You can specify multiple suffix as a list of string: 41 | # 42 | # source_suffix = ['.rst', '.md'] 43 | 44 | # The master toctree document. 45 | master_doc = 'index' 46 | 47 | # General information about the project. 48 | project = 'Chicken' 49 | copyright = '2021, Nicholas H.Tollervey' 50 | author = 'Nicholas H.Tollervey' 51 | 52 | # The version info for the project you're documenting, acts as replacement for 53 | # |version| and |release|, also used in various other places throughout the 54 | # built documents. 55 | # 56 | 57 | from chicken import __CHICKEN__ 58 | # The short X.Y version. 59 | version = __CHICKEN__ 60 | # The full version, including alpha/beta/rc tags. 61 | release = __CHICKEN__ 62 | 63 | # The language for content autogenerated by Sphinx. Refer to documentation 64 | # for a list of supported languages. 65 | # 66 | # This is also used if you do content translation via gettext catalogs. 67 | # Usually you set "language" from the command line for these cases. 68 | language = None 69 | 70 | # List of patterns, relative to source directory, that match files and 71 | # directories to ignore when looking for source files. 72 | # This patterns also effect to html_static_path and html_extra_path 73 | exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] 74 | 75 | # The name of the Pygments (syntax highlighting) style to use. 76 | pygments_style = 'sphinx' 77 | 78 | # If true, `todo` and `todoList` produce output, else they produce nothing. 79 | todo_include_todos = False 80 | 81 | 82 | # -- Options for HTML output ---------------------------------------------- 83 | 84 | # The theme to use for HTML and HTML Help pages. See the documentation for 85 | # a list of builtin themes. 86 | # 87 | html_theme = 'alabaster' 88 | 89 | # Theme options are theme-specific and customize the look and feel of a theme 90 | # further. For a list of options available for each theme, see the 91 | # documentation. 92 | # 93 | html_theme_options = { 94 | 'description': 'Chicken chicken chicken chicken chicken.', 95 | 'logo_name': True, 96 | 'logo_text_align': 'center', 97 | 'github_user': 'ntoll', 98 | 'github_repo': 'chckn', 99 | 100 | } 101 | 102 | 103 | html_logo = 'icon.png' 104 | 105 | # Add any paths that contain custom static files (such as style sheets) here, 106 | # relative to this directory. They are copied after the builtin static files, 107 | # so a file named "default.css" will overwrite the builtin "default.css". 108 | html_static_path = ['_static'] 109 | 110 | # Custom sidebar templates, must be a dictionary that maps document names 111 | # to template names. 112 | # 113 | # This is required for the alabaster theme 114 | # refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars 115 | html_sidebars = { 116 | '**': [ 117 | 'about.html', 118 | 'searchbox.html', 119 | ] 120 | } 121 | 122 | 123 | # -- Options for HTMLHelp output ------------------------------------------ 124 | 125 | # Output file base name for HTML help builder. 126 | htmlhelp_basename = 'Chickendoc' 127 | 128 | 129 | # -- Options for LaTeX output --------------------------------------------- 130 | 131 | latex_elements = { 132 | # The paper size ('letterpaper' or 'a4paper'). 133 | # 134 | # 'papersize': 'letterpaper', 135 | 136 | # The font size ('10pt', '11pt' or '12pt'). 137 | # 138 | # 'pointsize': '10pt', 139 | 140 | # Additional stuff for the LaTeX preamble. 141 | # 142 | # 'preamble': '', 143 | 144 | # Latex figure (float) alignment 145 | # 146 | # 'figure_align': 'htbp', 147 | } 148 | 149 | # Grouping the document tree into LaTeX files. List of tuples 150 | # (source start file, target name, title, 151 | # author, documentclass [howto, manual, or own class]). 152 | latex_documents = [ 153 | (master_doc, 'Chicken.tex', 'Chicken chicken', 154 | 'Nicholas H.Tollervey', 'manual'), 155 | ] 156 | 157 | 158 | # -- Options for manual page output --------------------------------------- 159 | 160 | # One entry per manual page. List of tuples 161 | # (source start file, name, description, authors, manual section). 162 | man_pages = [ 163 | (master_doc, 'arrr', 'Chicken chicken chicken.', 164 | [author], 1) 165 | ] 166 | 167 | 168 | # -- Options for Texinfo output ------------------------------------------- 169 | 170 | # Grouping the document tree into Texinfo files. List of tuples 171 | # (source start file, target name, title, author, 172 | # dir menu entry, description, category) 173 | texinfo_documents = [ 174 | (master_doc, 'Chicken', 'Chicken Documentation', 175 | author, 'Chicken', 'Chicken chicken chicken chicken chicken.', 176 | 'Miscellaneous'), 177 | ] 178 | --------------------------------------------------------------------------------