diff --git a/CHANGES b/CHANGES index a527a7baf01..2400cc01071 100644 --- a/CHANGES +++ b/CHANGES @@ -3707,8 +3707,7 @@ Deprecated * The ``trim_doctest_flags`` argument of ``sphinx.highlighting.PygmentsBridge`` is deprecated -For more details, see `deprecation APIs list -`_ +For more details, see :ref:`deprecation APIs list `. Features added -------------- @@ -4058,8 +4057,7 @@ Deprecated been changed (Since 1.7.0) * #4664: ``sphinx.ext.intersphinx.debug()`` is deprecated. -For more details, see `deprecation APIs list -`_ +For more details, see :ref:`deprecation APIs list `. Bugs fixed ---------- diff --git a/EXAMPLES b/EXAMPLES index 53127983727..5a787c36aef 100644 --- a/EXAMPLES +++ b/EXAMPLES @@ -13,7 +13,7 @@ Documentation using the alabaster theme --------------------------------------- * `Alabaster `__ -* `Blinker `__ +* `Blinker `__ * `Calibre `__ * `CherryPy `__ * `Click `__ (customized) @@ -55,7 +55,6 @@ Documentation using the classic theme * `Apache CouchDB `__ (customized) * `APSW `__ * `Arb `__ -* `Bazaar `__ (customized) * `Beautiful Soup `__ * `Blender API `__ * `Bugzilla `__ @@ -66,7 +65,6 @@ Documentation using the classic theme * `DEAP `__ (customized) * `Director `__ * `EZ-Draw `__ (customized) -* `F2py `__ * `Generic Mapping Tools (GMT) `__ (customized) * `Genomedata `__ * `GetFEM++ `__ (customized) @@ -115,11 +113,10 @@ Documentation using the sphinxdoc theme * `ABRT `__ * `cartopy `__ -* `Jython `__ +* `Jython `__ * `LLVM `__ * `MDAnalysis Tutorial `__ * `PyCantonese `__ -* `PyRe `__ * `Pyre `__ * `pySPACE `__ * `Pysparse `__ @@ -150,18 +147,20 @@ Documentation using another builtin theme ----------------------------------------- * `Breathe `__ (haiku) +* `Breezy (fork of Bazaar) `__ (agogo) * `MPipe `__ (sphinx13) * `NLTK `__ (agogo) * `PyPubSub `__ (bizstyle) * `Pylons `__ (pyramid) * `Pyramid web framework `__ (pyramid) -* `RxDock `__ +* `RxDock `__ (bizstyle) * `Sphinx `__ (sphinx13) :-) * `Valence `__ (haiku, customized) Documentation using sphinx_rtd_theme ------------------------------------ +* `Aesara (fork of Theano) `__ * `Annotator `__ * `Ansible `__ (customized) * `Arcade `__ @@ -226,7 +225,7 @@ Documentation using sphinx_rtd_theme * `Linux kernel `__ * `Mailman `__ * `MathJax `__ -* `MDTraj `__ (customized) +* `MDTraj `__ (customized) * `Mesa 3D `__ * `micca - MICrobial Community Analysis `__ * `MicroPython `__ @@ -256,7 +255,6 @@ Documentation using sphinx_rtd_theme * `PHPUnit `__ * `PHPWord `__ * `PROS `__ (customized) -* `Pushkin `__ * `Pweave `__ * `pyca/cryptograhpy `__ * `PyNaCl `__ @@ -272,12 +270,10 @@ Documentation using sphinx_rtd_theme * `Qtile `__ * `Quex `__ * `QuTiP `__ -* `Satchmo `__ * `Scapy `__ * `SimGrid `__ * `SimPy `__ * `six `__ -* `SlamData `__ * `Solidity `__ * `Sonos Controller (SoCo) `__ * `Sphinx AutoAPI `__ @@ -289,11 +285,10 @@ Documentation using sphinx_rtd_theme * `StarUML `__ * `Sublime Text Unofficial Documentation `__ * `SunPy `__ -* `Sylius `__ +* `Sylius `__ * `Syncthing `__ * `Tango Controls `__ (customized) * `Topshelf `__ -* `Theano `__ * `ThreatConnect `__ * `TrueNAS `__ (customized) * `Tuleap `__ @@ -319,7 +314,6 @@ Documentation using sphinx_bootstrap_theme * `Hangfire `__ * `Hedge `__ * `ObsPy `__ -* `Open Dylan `__ * `OPNFV `__ * `Pootle `__ * `PyUblas `__ @@ -343,6 +337,7 @@ Documentation using pydata_sphinx_theme * `NetworkX `__ * `Numpy `__ * `Pandas `__ +* `Pystra (continuation of PyRe) `__ * `PyVista `__ * `SciPy `__ * `SEPAL `__ @@ -375,10 +370,10 @@ Documentation using a custom theme or integrated in a website * `Heka `__ * `Istihza (Turkish Python documentation project) `__ * `JupyterHub `__ -* `Kombu `__ -* `Lasso `__ +* `Kombu `__ +* `Lasso `__ * `Mako `__ -* `MirrorBrain `__ +* `MirrorBrain `__ * `Mitiq `__ * `MongoDB `__ * `Music21 `__ @@ -389,6 +384,7 @@ Documentation using a custom theme or integrated in a website * `ObjectListView `__ * `OpenERP `__ * `OpenCV `__ +* `Open Dylan `__ * `OpenLayers `__ * `OpenTURNS `__ * `Open vSwitch `__ @@ -401,7 +397,6 @@ Documentation using a custom theme or integrated in a website * `PyMOTW `__ * `python-aspectlib `__ (`sphinx_py3doc_enhanced_theme `__) * `QGIS `__ -* `qooxdoo `__ * `Roundup `__ * `SaltStack `__ * `scikit-learn `__ @@ -415,7 +410,6 @@ Documentation using a custom theme or integrated in a website * `tinyTiM `__ * `Twisted `__ * `Ubuntu Packaging Guide `__ -* `WebFaction `__ * `WTForms `__ Homepages and other non-documentation sites @@ -429,15 +423,14 @@ Homepages and other non-documentation sites * `Florian Diesch `__ * `Institute for the Design of Advanced Energy Systems (IDAES) `__ (sphinx_rtd_theme) * `IDAES Examples `__ (sphinx_rtd_theme) -* `Lei Ma's Statistical Mechanics lecture notes `__ (sphinx_bootstrap_theme) +* `Lei Ma's Statistical Mechanics lecture notes `__ (sphinx_bootstrap_theme) * `Loyola University Chicago CS Academic Programs `__ (sphinx_rtd_theme, customized) * `PyXLL `__ (sphinx_bootstrap_theme, customized) * `SciPy Cookbook `__ (sphinx_rtd_theme) -* `Tech writer at work blog `__ (custom theme) -* `The Wine Cellar Book `__ (sphinxdoc) +* `Tech writer at work blog `__ (custom theme) * `Thomas Cokelaer's Python, Sphinx and reStructuredText tutorials `__ (standard) * `UC Berkeley ME233 Advanced Control Systems II course `__ (sphinxdoc) -* `Željko Svedružić's Biomolecular Structure and Function Laboratory (BioSFLab) `__ (sphinx_bootstrap_theme) +* `Željko Svedružić's Biomolecular Structure and Function Laboratory (BioSFLab) `__ (sphinx_bootstrap_theme) Books produced using Sphinx --------------------------- @@ -448,7 +441,7 @@ Books produced using Sphinx * `"Expert Python Programming" (Japanese translation) `__ * `"Expert Python Programming 2nd Edition" (Japanese translation) `__ * `"The Hitchhiker's Guide to Python" `__ -* `"LassoGuide" `__ +* `"LassoGuide" `__ * `"Learning Sphinx" (in Japanese) `__ * `"Learning System Programming with Go (Japanese)" `__ * `"Mercurial: the definitive guide (Second edition)" `__ @@ -472,8 +465,6 @@ Books produced using Sphinx Theses produced using Sphinx ---------------------------- -* `"A Web-Based System for Comparative Analysis of OpenStreetMap Data by the Use - of CouchDB" `__ * `"Content Conditioning and Distribution for Dynamic Virtual Worlds" `__ * `"The Sphinx Thesis Resource" `__ diff --git a/doc/conf.py b/doc/conf.py index 8bf8d90a708..c4effb870ab 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -82,6 +82,8 @@ latex_show_urls = 'footnote' latex_use_xindy = True +linkcheck_timeout = 5 + autodoc_member_order = 'groupwise' autosummary_generate = False todo_include_todos = True