From 2bd08c8254d56415f24d55f7ee58c1eda56867b1 Mon Sep 17 00:00:00 2001 From: Mads Marquart Date: Wed, 3 Jul 2019 14:20:37 +0200 Subject: [PATCH] Update Sphinx to version 2.0 --- docs/api.rst | 2 +- docs/conf.py | 2 +- docs/faq.rst | 2 +- docs/index.rst | 2 +- docs/intro.rst | 2 +- docs/testing.rst | 6 +----- docs/todo.rst | 2 +- pyproject.toml | 3 +++ 8 files changed, 10 insertions(+), 11 deletions(-) diff --git a/docs/api.rst b/docs/api.rst index 3c9202a..244e596 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -1,4 +1,4 @@ -.. module:: fbchat +.. currentmodule:: fbchat .. highlight:: python .. _api: diff --git a/docs/conf.py b/docs/conf.py index ecd4474..f3a47ae 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -31,7 +31,7 @@ release = fbchat.__version__ # If your documentation needs a minimal Sphinx version, state it here. # -# needs_sphinx = '1.0' +needs_sphinx = "2.0" # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom diff --git a/docs/faq.rst b/docs/faq.rst index d4bcc1a..c1c1602 100644 --- a/docs/faq.rst +++ b/docs/faq.rst @@ -1,5 +1,5 @@ .. highlight:: python -.. module:: fbchat +.. currentmodule:: fbchat .. _faq: FAQ diff --git a/docs/index.rst b/docs/index.rst index 67a8c11..653bc05 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,5 +1,5 @@ .. highlight:: python -.. module:: fbchat +.. currentmodule:: fbchat .. fbchat documentation master file, created by sphinx-quickstart on Thu May 25 15:43:01 2017. You can adapt this file completely to your liking, but it should at least diff --git a/docs/intro.rst b/docs/intro.rst index 8fabddd..c1a501d 100644 --- a/docs/intro.rst +++ b/docs/intro.rst @@ -1,5 +1,5 @@ .. highlight:: python -.. module:: fbchat +.. currentmodule:: fbchat .. _intro: Introduction diff --git a/docs/testing.rst b/docs/testing.rst index f7d01a0..7b73608 100644 --- a/docs/testing.rst +++ b/docs/testing.rst @@ -1,5 +1,5 @@ .. highlight:: sh -.. module:: fbchat +.. currentmodule:: fbchat .. _testing: Testing @@ -23,7 +23,3 @@ If you only want to execute specific tests, pass the function names in the comma Do not execute the full set of tests in too quick succession. This can get your account temporarily blocked for spam! (You should execute the script at max about 10 times a day) - -.. automodule:: tests - :members: TestFbchat - :undoc-members: TestFbchat diff --git a/docs/todo.rst b/docs/todo.rst index d0af13b..33b3ab9 100644 --- a/docs/todo.rst +++ b/docs/todo.rst @@ -1,5 +1,5 @@ .. highlight:: python -.. module:: fbchat +.. currentmodule:: fbchat .. _todo: Todo diff --git a/pyproject.toml b/pyproject.toml index d4473e3..e309e40 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -54,6 +54,9 @@ test = [ "pytest~=4.0", "six~=1.0", ] +docs = [ + "sphinx~=2.0", +] lint = [ "black", ]