centersl/mkdocs
1
0
Fork 0
mirror of https://github.com/mkdocs/mkdocs.git synced 2026-03-27 09:58:31 +07:00
Code Issues Packages Projects Releases Wiki Activity

Remove PyPI Deployment Docs.

Browse Source 
PyPI's documentation hosting has been deprecated, and in fact, it
is no longer possable to upload documentation to PyPI. Therefore,
it is a disservice to our users to document how to deploy to that
service.

See the mailing list dicussions for the official announcement:
https://mail.python.org/pipermail/distutils-sig/2015-May/026327.html
https://mail.python.org/pipermail/distutils-sig/2015-May/026381.html
This commit is contained in:
Waylan Limberg
2017-12-07 11:32:29 -05:00
parent 4c7c69cd3a
commit dfb50c9160
1 changed files with 0 additions and 36 deletions
Download Patch File Download Diff File Expand all files Collapse all files

36
docs/user-guide/deploying-your-docs.md
View File

@@ -58,42 +58,6 @@ public repository.
[features]: http://read-the-docs.readthedocs.io/en/latest/features.html
[theme]: /user-guide/styling-your-docs.md
## PyPI
If you maintain a [Python] project which is hosted on the [Python Package
Index][PyPI] (PyPI), you can use the hosting provided at [pythonhosted.org] to
host documentation for your project. Run the following commands from your
project's root directory to upload your documentation:
```sh
mkdocs build
python setup.py upload_docs --upload-dir=site
```
Your documentation will be hosted at `https://pythonhosted.org/<projectname>/`
where `<projectname>` is the name you used to register your project with PyPI.
There are a few prerequisites for the above to work:
1. You must be using [Setuptools] in your `setup.py` script ([Distutils] does
not offer an `upload_docs` command).
1. Your project must already be registered with PyPI (use `python setup.py
register`).
1. Your `mkdocs.yml` config file and your "docs" directory (value assigned to
the [docs_dir] configuration option) are presumed to be in the root directory
of your project alongside your `setup.py` script.
1. It is assumed that the default value (`"site"`) is assigned to the [site_dir]
configuration option in your `mkdocs.yaml` config file. If you have set a
different value, assign that value to the `--upload-dir` option.
[Python]: http://www.python.org/
[PyPI]: https://pypi.python.org/pypi
[pythonhosted.org]: https://pythonhosted.org/
[Setuptools]: https://pythonhosted.org/setuptools/
[Distutils]: https://docs.python.org/2/distutils/
[docs_dir]: configuration.md#docs_dir
[site_dir]: configuration.md#site_dir
## Other Providers
Any hosting provider which can serve static files can be used to serve