1 # Buildsheet autogenerated by ravenadm tool -- Do not edit.
3 NAMEBASE= python-mkdocs
7 SDESC[py310]= Project documentation with Markdown (3.10)
8 SDESC[v11]= Project documentation with Markdown (3.11)
10 CONTACT= Python_Automaton[python@ironwolf.systems]
13 SITES[main]= PYPIWHL/14/f4/66760e770dd1eb4b3aab7b7e3e97c5ec5c0d8c4f66ebbd32f1cb5cf53139
14 DISTFILE[1]= mkdocs-1.5.2-py3-none-any.whl:main
19 OPTIONS_AVAILABLE= PY310 PY311
20 OPTIONS_STANDARD= none
21 VOPTS[py310]= PY310=ON PY311=OFF
22 VOPTS[v11]= PY310=OFF PY311=ON
24 DISTNAME= mkdocs-1.5.2.dist-info
28 [PY310].RUN_DEPENDS_ON= python-click:single:py310
29 python-colorama:single:py310
30 python-ghp-import:single:py310
31 python-Jinja2:single:py310
32 python-Markdown:single:py310
33 python-MarkupSafe:single:py310
34 python-mergedeep:single:py310
35 python-packaging:single:py310
36 python-pathspec:single:py310
37 python-platformdirs:single:py310
38 python-pyyaml-env-tag:single:py310
39 python-PyYAML:single:py310
40 python-watchdog:single:py310
41 [PY310].USES_ON= python:py310,wheel
43 [PY311].RUN_DEPENDS_ON= python-click:single:v11
44 python-colorama:single:v11
45 python-ghp-import:single:v11
46 python-Jinja2:single:v11
47 python-Markdown:single:v11
48 python-MarkupSafe:single:v11
49 python-mergedeep:single:v11
50 python-packaging:single:v11
51 python-pathspec:single:v11
52 python-platformdirs:single:v11
53 python-pyyaml-env-tag:single:v11
54 python-PyYAML:single:v11
55 python-watchdog:single:v11
56 [PY311].USES_ON= python:v11,wheel
58 [FILE:3094:descriptions/desc.single]
61 > *Project documentation with Markdown*
63 [![PyPI Version][pypi-v-image]][pypi-v-link]
64 [![Build Status][GHAction-image]][GHAction-link]
65 [![Coverage Status][codecov-image]][codecov-link]
67 MkDocs is a **fast**, **simple** and **downright gorgeous** static site
68 generator that's geared towards building project documentation.
70 source files are written in Markdown, and configured with a single YAML
71 configuration file. It is designed to be easy to use and can be extended
73 third-party themes, plugins, and Markdown extensions.
75 Please see the [Documentation][mkdocs] for an introductory tutorial and a
81 - Build static HTML files from Markdown files.
82 - Use Plugins and Markdown Extensions to enhance MkDocs.
83 - Use the built-in themes, third party themes or create your own.
84 - Publish your documentation anywhere that static files can be served.
89 If you need help with MkDocs, do not hesitate to get in contact with us!
91 - For questions and high-level discussions, use **[Discussions]** on
93 - For small questions, a good alternative is the **[Chat room]** on
95 - To report a bug or make a feature request, open an **[Issue]** on
98 Please note that we may only provide
99 support for problems/questions regarding core features of MkDocs. Any
100 questions or bug reports about features of third-party themes, plugins,
101 extensions or similar should be made to their respective projects.
102 But, such questions are *not* banned from the [chat room].
104 Make sure to stick around to answer some questions as well!
108 - [Official Documentation][mkdocs]
109 - [Latest Release Notes][release-notes]
110 - [Catalog of third-party plugins, themes and recipes][catalog]
112 ## Contributing to MkDocs
114 The MkDocs project welcomes, and depends on, contributions from developers
116 users in the open source community. Please see the [Contributing Guide] for
117 information on how you can help.
121 Everyone interacting in the MkDocs project's codebases, issue trackers, and
122 discussion forums is expected to follow the [PyPA Code of Conduct].
126 https://codecov.io/github/mkdocs/mkdocs/coverage.svg?branch=master
127 [codecov-link]: https://codecov.io/github/mkdocs/mkdocs?branch=master
128 [pypi-v-image]: https://img.shields.io/pypi/v/mkdocs.svg
129 [pypi-v-link]: https://pypi.org/project/mkdocs/
131 https://github.com/mkdocs/mkdocs/workflows/CI/badge.svg?branch=master&event=push
133 https://github.com/mkdocs/mkdocs/actions?query=event%3Apush+branch%3Amaster
135 [mkdocs]: https://www.mkdocs.org
136 [Issue]: https://github.com/mkdocs/mkdocs/issues
137 [Discussions]: https://github.com/mkdocs/mkdocs/discussions
138 [Chat room]: https://gitter.im/mkdocs/community
139 [release-notes]: https://www.mkdocs.org/about/release-notes/
140 [Contributing Guide]: https://www.mkdocs.org/about/contributing/
141 [PyPA Code of Conduct]: https://www.pypa.io/en/latest/code-of-conduct/
142 [catalog]: https://github.com/mkdocs/catalog
150 60a62538519c2e96fe8426654a67ee177350451616118a41596ae7c876bb7eac 3672139 mkdocs-1.5.2-py3-none-any.whl