diff options
| author | Jeff Forcier <jeff@bitprophet.org> | 2021-10-01 15:12:46 -0400 |
|---|---|---|
| committer | Jeff Forcier <jeff@bitprophet.org> | 2021-10-01 22:04:36 -0400 |
| commit | 985c5d0c811987a9d4d9fff712169e5125acc95a (patch) | |
| tree | 0039ec3ea3c9ddf3aee64aa6a868eac0c32ca362 /sites | |
| parent | 6359fb16d4d31a0ae1cdca865dd428334023a363 (diff) | |
README / www-index overhaul
- Nuke old README in its entirety:
- We don't want people using demos if possible, stop advertising them
- Nix a bunch of bits that will now be replaced by standard PyPI sidebar links (docs, tests etc)
- Ditto the 'headers', most of that stuff is either PyPI metadata or the about to be added shields.io badges
- Some stuff deleted was also just old, eg IRC is no longer a support channel and I think librelist is dead too
- Rip out www site index for use as README and inject back in via
include
- Rewrite a bunch of that too for clarity
- Leverage it in long_description too
Diffstat (limited to 'sites')
| -rw-r--r-- | sites/www/changelog.rst | 2 | ||||
| -rw-r--r-- | sites/www/index.rst | 25 |
2 files changed, 2 insertions, 25 deletions
diff --git a/sites/www/changelog.rst b/sites/www/changelog.rst index 8d446990..55a6a785 100644 --- a/sites/www/changelog.rst +++ b/sites/www/changelog.rst @@ -7,7 +7,7 @@ Changelog - Migrate CI to CircleCI - Primary dev branch is now ``main`` (renamed) - Many README edits for clarity, modernization etc; including a bunch more - (and consistent) status badges + (and consistent) status badges & unification with main project site index - PyPI page much more fleshed out (long_description is now filled in with the README; sidebar links expanded; etc) - flake8, pytest configs split out of setup.cfg into their own files diff --git a/sites/www/index.rst b/sites/www/index.rst index 656031aa..9c3bb3aa 100644 --- a/sites/www/index.rst +++ b/sites/www/index.rst @@ -1,20 +1,4 @@ -Welcome to Paramiko! -==================== - -Paramiko is a Python (2.7, 3.4+) implementation of the SSHv2 protocol [#]_, -providing both client and server functionality. While it leverages a Python C -extension for low level cryptography (`Cryptography -<https://cryptography.io>`_), Paramiko itself is a pure Python interface around -SSH networking concepts. - -This website covers project information for Paramiko such as the changelog, -contribution guidelines, development roadmap, news/blog, and so forth. Detailed -usage and API documentation can be found at our code documentation site, -`docs.paramiko.org <http://docs.paramiko.org>`_. Additionally, the project -maintainer keeps a `roadmap <http://bitprophet.org/projects#roadmap>`_ on his -website. - -Please see the sidebar to the left to begin. +.. include:: ../../README.rst .. toctree:: :hidden: @@ -27,10 +11,3 @@ Please see the sidebar to the left to begin. contact -.. rubric:: Footnotes - -.. [#] - SSH is defined in :rfc:`4251`, :rfc:`4252`, :rfc:`4253` and :rfc:`4254`. The - primary working implementation of the protocol is the `OpenSSH project - <http://openssh.org>`_. Paramiko implements a large portion of the SSH - feature set, but there are occasional gaps. |