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/ff/00/58f2939f8e6c5f981d9ad9b685c9915a3b315c8f34ba93f0020d64929f70
14 DISTFILE[1]= mkdocs-1.4.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.4.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-mergedeep:single:py310
34 python-packaging:single:py310
35 python-pyyaml-env-tag:single:py310
36 python-PyYAML:single:py310
37 python-watchdog:single:py310
38 [PY310].USES_ON= python:py310,wheel
40 [PY311].RUN_DEPENDS_ON= python-click:single:v11
41 python-colorama:single:v11
42 python-ghp-import:single:v11
43 python-Jinja2:single:v11
44 python-Markdown:single:v11
45 python-mergedeep:single:v11
46 python-packaging:single:v11
47 python-pyyaml-env-tag:single:v11
48 python-PyYAML:single:v11
49 python-watchdog:single:v11
50 [PY311].USES_ON= python:v11,wheel
52 [FILE:3235:descriptions/desc.single]
55 > *Project documentation with Markdown*
57 [![PyPI Version][pypi-v-image]][pypi-v-link]
58 [![Build Status][GHAction-image]][GHAction-link]
59 [![Coverage Status][codecov-image]][codecov-link]
61 MkDocs is a **fast**, **simple** and **downright gorgeous** static site
62 generator that's geared towards building project documentation.
64 source files are written in Markdown, and configured with a single YAML
65 configuration file. It is designed to be easy to use and can be extended
67 third-party themes, plugins, and Markdown extensions.
69 Please see the [Documentation][mkdocs] for an introductory tutorial and a
75 - Build static HTML files from Markdown files.
76 - Use Plugins and Markdown Extensions to enhance MkDocs.
77 - Use the built-in themes, third party themes or create your own.
78 - Publish your documentation anywhere that static files can be served.
83 If you need help with MkDocs, do not hesitate to get in contact with us!
85 - For questions and high-level discussions, use **[Discussions]** on
87 - For small questions, a good alternative is the **[Chat room]** on
88 Gitter/Matrix (**new!**)
89 - To report a bug or make a feature request, open an **[Issue]** on
92 Please note that we may only provide
93 support for problems/questions regarding core features of MkDocs. Any
94 questions or bug reports about features of third-party themes, plugins,
95 extensions or similar should be made to their respective projects.
96 But, such questions are *not* banned from the [chat room].
98 Make sure to stick around to answer some questions as well!
102 - [Official Documentation][mkdocs]
103 - [Latest Release Notes][release-notes]
104 - [MkDocs Wiki][wiki] (Third-party themes, recipes, plugins and more)
105 - [Best-of-MkDocs][best-of] (Curated list of themes, plugins and more)
107 ## Contributing to MkDocs
109 The MkDocs project welcomes, and depends on, contributions from developers
111 users in the open source community. Please see the [Contributing Guide] for
112 information on how you can help.
116 Everyone interacting in the MkDocs project's codebases, issue trackers, and
117 discussion forums is expected to follow the [PyPA Code of Conduct].
121 https://codecov.io/github/mkdocs/mkdocs/coverage.svg?branch=master
122 [codecov-link]: https://codecov.io/github/mkdocs/mkdocs?branch=master
123 [pypi-v-image]: https://img.shields.io/pypi/v/mkdocs.svg
124 [pypi-v-link]: https://pypi.org/project/mkdocs/
126 https://github.com/mkdocs/mkdocs/workflows/CI/badge.svg?branch=master&event=push
128 https://github.com/mkdocs/mkdocs/actions?query=event%3Apush+branch%3Amaster
130 [mkdocs]: https://www.mkdocs.org
131 [Issue]: https://github.com/mkdocs/mkdocs/issues
132 [Discussions]: https://github.com/mkdocs/mkdocs/discussions
133 [Chat room]: https://gitter.im/mkdocs/community
134 [release-notes]: https://www.mkdocs.org/about/release-notes/
135 [wiki]: https://github.com/mkdocs/mkdocs/wiki
136 [Contributing Guide]: https://www.mkdocs.org/about/contributing/
137 [PyPA Code of Conduct]: https://www.pypa.io/en/latest/code-of-conduct/
138 [best-of]: https://github.com/pawamoy/best-of-mkdocs
146 c8856a832c1e56702577023cd64cc5f84948280c1c0fcc6af4cd39006ea6aa8c 3652203 mkdocs-1.4.2-py3-none-any.whl