Skip to content

Commit

Permalink
Revised docs for release 7.0.
Browse files Browse the repository at this point in the history
  • Loading branch information
lextm committed Aug 22, 2024
1 parent e98911a commit 87f9483
Show file tree
Hide file tree
Showing 4 changed files with 24 additions and 9 deletions.
6 changes: 4 additions & 2 deletions SECURITY.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,11 @@

## Supported Versions

Only 5.0/6.x releases are currently being supported with security updates.
Only 6.x/7.x releases are currently being supported with security updates.

| Version | Supported |
| ------- | ------------------ |
| 7.0.x | :white_check_mark: |
| 6.2.x | :white_check_mark: |
| 6.1.x | :white_check_mark: |
| 6.0.x | :white_check_mark: |
Expand All @@ -17,4 +18,5 @@ Only 5.0/6.x releases are currently being supported with security updates.

## Reporting a Vulnerability

Please contact [LeXtudio Inc.](https://lextudio.com) directly to report a vulnerability.
Please contact [LeXtudio Inc.](https://lextudio.com) directly to report a
vulnerability.
2 changes: 1 addition & 1 deletion docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -149,7 +149,7 @@

# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".
html_title = "PySNMP 6.2 Documentation"
html_title = "PySNMP 7 Documentation"

# A shorter title for the navigation bar. Default is the same as html_title.
# html_short_title = None
Expand Down
6 changes: 3 additions & 3 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.. include:: /includes/_links.rst

SNMP Library for Python 6.2
===========================
SNMP Library for Python 7
=========================

.. toctree::
:maxdepth: 1
Expand All @@ -19,7 +19,7 @@ multilingual capabilities, remote configuration and other features.
PySNMP implementation closely follows intricate system details and features
bringing most possible power and flexibility to its users.

Current PySNMP stable version is 6.2. It runs with Python 3.8+
Current PySNMP stable version is 7.0. It runs with Python 3.8+
and is recommended for new applications as well as for migration from
older, now obsolete, PySNMP releases. All site documentation and
examples are written for the 6.0 and later versions in mind.
Expand Down
19 changes: 16 additions & 3 deletions docs/source/upgrade.rst
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
.. include:: /includes/_links.rst

Upgrade to 6.x Releases
=======================
Upgrade to 6.x/7.x Releases
===========================

.. toctree::
:maxdepth: 2

This article provides information on how to upgrade to the latest 6.x
This article provides information on how to upgrade to the latest 6.x/7.0
releases from old releases such as 4.x and 5.x.

.. note::
Expand Down Expand Up @@ -188,6 +188,19 @@ we decided to remove it from 6.2 release.
older 6.2 releases. The new 6.2 releases were published to ensure smooth
transition for users who are still using the 4.x/5.x/6.0/6.1 releases.

Upgrade to 7.0 Releases
-----------------------

The code base wasn't compliant to many Python standards, such as PEP8. So,
we decided to clean up the code base and make it more compliant to the
standards in 7.0 release.

.. important::

Since API surface changes are significant, users who upgrade from 6.x
releases should carefully review the changes and adjust their code
accordingly.

Important Changes
-----------------

Expand Down

0 comments on commit 87f9483

Please sign in to comment.