From ec3ae4118da8b00a136cea6dc5f68dc826b0ffb2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Piotr=20Ma=C5=9Blanka?= <piotr.maslanka@henrietta.com.pl> Date: Sat, 28 Dec 2019 21:28:43 +0100 Subject: [PATCH] 2.1.10rc1: fixed docs --- CHANGELOG.md | 3 ++- docs/conf.py | 2 +- docs/index.rst | 17 +++++++++-------- .../instrumentation/{metrics.md => metrics.rst} | 3 +++ satella/__init__.py | 2 +- setup.cfg | 2 +- 6 files changed, 17 insertions(+), 12 deletions(-) rename docs/instrumentation/{metrics.md => metrics.rst} (99%) diff --git a/CHANGELOG.md b/CHANGELOG.md index ec44b09b..ccb26982 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,6 +1,7 @@ # v2.1.10 -* _TBA_ +* added [metrics](satella/instrumentation/metrics) +* [documentation](https://satella.readthedocs.io/en/develop/) improved # v2.1.9 diff --git a/docs/conf.py b/docs/conf.py index 654fa5c0..3a7e1863 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -51,7 +51,7 @@ master_doc = 'index' # General information about the project. project = u'satella' -copyright = u'2017-2018, Piotr MaĹlanka' +copyright = u'2017-2019, Piotr MaĹlanka' author = u'Piotr MaĹlanka' # The version info for the project you're documenting, acts as replacement for diff --git a/docs/index.rst b/docs/index.rst index 453d3b89..a47ed1ce 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -5,14 +5,15 @@ Welcome to satella's documentation! :maxdepth: 2 :caption: Contents: - coding/monitor - coding/debug - coding/typechecking - coding/structures - instrumentation/traceback - instrumentation/metrics - source/modules - posix + coding/monitor + coding/debug + coding/typechecking + coding/structures + instrumentation/traceback + instrumentation/metrics + source/modules + posix + recipes Indices and tables diff --git a/docs/instrumentation/metrics.md b/docs/instrumentation/metrics.rst similarity index 99% rename from docs/instrumentation/metrics.md rename to docs/instrumentation/metrics.rst index 2118fccb..9440cd8f 100644 --- a/docs/instrumentation/metrics.md +++ b/docs/instrumentation/metrics.rst @@ -1,3 +1,6 @@ +Metrics +------- + Metrics and instruments are a system to output real-time statistics. Metrics are defined and meant to be used in a similar way diff --git a/satella/__init__.py b/satella/__init__.py index 1617bb15..861666c6 100644 --- a/satella/__init__.py +++ b/satella/__init__.py @@ -1,3 +1,3 @@ # coding=UTF-8 -__version__ = '2.1.10a5' +__version__ = '2.1.10rc1' diff --git a/setup.cfg b/setup.cfg index dc321ce6..a4f1ae15 100644 --- a/setup.cfg +++ b/setup.cfg @@ -10,7 +10,7 @@ author_email = piotrm@smok.co description = Utilities for writing servers in Python url = https://github.com/piotrmaslanka/satella project-urls = - Documentation = https://satella.readthedocs.io/ + Documentation = https://satella.readthedocs.io/en/develop/ classifier = Programming Language :: Python Programming Language :: Python :: 3.5 -- GitLab