codex
122 lines
4.7 KiB
Plaintext
122 lines
4.7 KiB
Plaintext
Metadata-Version: 2.4
|
|
Name: properdocs
|
|
Version: 1.6.7
|
|
Summary: Project documentation with Markdown.
|
|
Project-URL: Documentation, https://properdocs.org/
|
|
Project-URL: Source, https://github.com/properdocs/properdocs
|
|
Project-URL: Issues, https://github.com/properdocs/properdocs/issues
|
|
Project-URL: History, https://github.com/properdocs/properdocs/releases
|
|
Author-email: Tom Christie <tom@tomchristie.com>
|
|
License-Expression: BSD-2-Clause
|
|
License-File: LICENSE
|
|
Classifier: Development Status :: 5 - Production/Stable
|
|
Classifier: Environment :: Console
|
|
Classifier: Environment :: Web Environment
|
|
Classifier: Intended Audience :: Developers
|
|
Classifier: License :: OSI Approved :: BSD License
|
|
Classifier: Operating System :: OS Independent
|
|
Classifier: Programming Language :: Python
|
|
Classifier: Programming Language :: Python :: 3
|
|
Classifier: Programming Language :: Python :: 3.9
|
|
Classifier: Programming Language :: Python :: 3.10
|
|
Classifier: Programming Language :: Python :: 3.11
|
|
Classifier: Programming Language :: Python :: 3.12
|
|
Classifier: Programming Language :: Python :: 3.13
|
|
Classifier: Programming Language :: Python :: 3.14
|
|
Classifier: Topic :: Documentation
|
|
Classifier: Topic :: Text Processing
|
|
Classifier: Typing :: Typed
|
|
Requires-Python: >=3.9
|
|
Requires-Dist: click>=7.0
|
|
Requires-Dist: colorama>=0.4; platform_system == 'Windows'
|
|
Requires-Dist: ghp-import>=1.0
|
|
Requires-Dist: importlib-metadata>=4.4; python_version < '3.10'
|
|
Requires-Dist: jinja2>=2.11.1
|
|
Requires-Dist: markdown>=3.3.6
|
|
Requires-Dist: markupsafe>=2.0.1
|
|
Requires-Dist: packaging>=20.5
|
|
Requires-Dist: pathspec>=0.11.1
|
|
Requires-Dist: platformdirs>=2.2.0
|
|
Requires-Dist: pyyaml-env-tag>=0.1
|
|
Requires-Dist: pyyaml>=5.1
|
|
Requires-Dist: watchdog>=2.0
|
|
Provides-Extra: i18n
|
|
Requires-Dist: babel>=2.9.0; extra == 'i18n'
|
|
Description-Content-Type: text/markdown
|
|
|
|
# ProperDocs
|
|
|
|
> *Project documentation with Markdown*
|
|
|
|
[![PyPI Version][pypi-v-image]][pypi-v-link]
|
|
[![Build Status][GHAction-image]][GHAction-link]
|
|
|
|
ProperDocs is a **fast**, **simple** and **downright gorgeous** static site
|
|
generator that's geared towards building project documentation. Documentation
|
|
source files are written in Markdown, and configured with a single YAML
|
|
configuration file. It is designed to be easy to use and can be extended with
|
|
third-party themes, plugins, and Markdown extensions.
|
|
|
|
Please see the [Documentation][properdocs] for an introductory tutorial and a full
|
|
user guide.
|
|
|
|
## Features
|
|
|
|
- Build static HTML files from Markdown files.
|
|
- Use Plugins and Markdown Extensions to enhance ProperDocs.
|
|
- Use third party themes or create your own.
|
|
- Publish your documentation anywhere that static files can be served.
|
|
- Much more!
|
|
|
|
## Support
|
|
|
|
If you need help with ProperDocs, do not hesitate to get in contact with us!
|
|
|
|
- For questions and high-level discussions, use **[Discussions]** on GitHub.
|
|
- For small questions, a good alternative is the **[Discord server]**.
|
|
- To report a bug or make a feature request, open an **[Issue]** on GitHub.
|
|
|
|
Please note that we may only provide
|
|
support for problems/questions regarding core features of ProperDocs. Any
|
|
questions or bug reports about features of third-party themes, plugins,
|
|
extensions or similar should be made to their respective projects.
|
|
But, such questions are *not* banned from the [chat room].
|
|
|
|
Make sure to stick around to answer some questions as well!
|
|
|
|
## Links
|
|
|
|
- [Official Documentation][properdocs]
|
|
- [Latest Release Notes][release-notes]
|
|
- [Catalog of third-party plugins, themes and recipes][catalog]
|
|
|
|
## Contributing to ProperDocs
|
|
|
|
The ProperDocs project welcomes, and depends on, contributions from developers and
|
|
users in the open source community. Please see the [Contributing Guide] for
|
|
information on how you can help.
|
|
|
|
## Code of Conduct
|
|
|
|
Everyone interacting in the ProperDocs project's codebases, issue trackers, and
|
|
discussion forums is expected to follow the [PyPA Code of Conduct].
|
|
|
|
<!-- Badges -->
|
|
[pypi-v-image]: https://img.shields.io/pypi/v/properdocs.svg
|
|
[pypi-v-link]: https://pypi.org/project/properdocs/
|
|
[GHAction-image]: https://github.com/properdocs/properdocs/actions/workflows/ci.yml/badge.svg
|
|
[GHAction-link]: https://github.com/properdocs/properdocs/actions/workflows/ci.yml
|
|
<!-- Links -->
|
|
[properdocs]: https://properdocs.org
|
|
[Issue]: https://github.com/properdocs/properdocs/issues
|
|
[Discussions]: https://github.com/properdocs/properdocs/discussions
|
|
[Discord server]: https://discord.gg/CwYAgEPHZd
|
|
[release-notes]: https://properdocs.org/about/release-notes/
|
|
[Contributing Guide]: https://properdocs.org/about/contributing/
|
|
[PyPA Code of Conduct]: https://www.pypa.io/en/latest/code-of-conduct/
|
|
[catalog]: https://github.com/properdocs/catalog
|
|
|
|
## License
|
|
|
|
[BSD-2-Clause](https://github.com/properdocs/properdocs/blob/master/LICENSE)
|