Metadata-Version: 2.4
Name: docput
Version: 1.0.1
Summary: Deploy multi-versioned docs to static hosting
Author-email: Andrew Cassidy <drewcassidy@me.com>
License-Expression: MIT
Project-URL: Source, https://git.offworld.city/drewcassidy/docput
Project-URL: Documentation, https://drewcassidy.me/docput/latest/
Keywords: sphinx,git-pages,documentation,ci
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Environment :: Console
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: JavaScript
Classifier: Topic :: Utilities
Classifier: Topic :: Documentation
Classifier: Topic :: Documentation :: Sphinx
Classifier: Topic :: Internet :: WWW/HTTP :: Site Management
Classifier: Topic :: Software Development :: Documentation
Classifier: Framework :: Sphinx
Classifier: Framework :: Sphinx :: Extension
Requires-Python: >=3.14
Description-Content-Type: text/markdown
License-File: LICENSE.md
Requires-Dist: click>=8.4
Requires-Dist: requests>=2.33
Requires-Dist: urlpath>=2.0.0
Dynamic: license-file

# docput

[source] • [documentation] • [pypi]

<!-- begin-pitch -->

docput is a command line tool and library
that allows you to easily deploy versioned documentation
to static web hosts.

docput can deploy to
[git-pages](https://git-pages.org) instances
such as [Codeberg Pages](https://docs.codeberg.org/codeberg-pages/),
or to the local filesystem.

Each version of your documentation
is deployed to its own subfolder,
and does not need to be rebuilt
when other versions are added.
A version manifest
and sphinx extension
allow switching between versions with a drop-down menu.

<!-- end-pitch -->

## Installation

Install and update with [pip](https://pip.pypa.io/en/stable/getting-started/):

```shell
$ pip install docput
```

[documentation]: https://drewcassidy.me/docput/latest/
[pypi]: https://pypi.org/project/docput
[source]: https://git.offworld.city/drewcassidy/docput

## Licensing

Docput is distributed under [the MIT license](LICENSE.md)

Note that we *do not* waive the attribution requirements of our
licenses, including for ingestion into machine learning models. If you
train on and produce code derived from our work, you must uphold all
attribution requirements in produced works.
