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