summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRoss Barnowski <rossbar@berkeley.edu>2021-05-12 22:42:00 -0700
committerGitHub <noreply@github.com>2021-05-12 22:42:00 -0700
commitba7992d8cb8fd0ae08a1a23144db4f3e23178673 (patch)
treee4075b35e565fc8b538985e50b97965821a206a0
parente34e035e221fc3e261c5094aaa1588650a87633d (diff)
downloadnetworkx-ba7992d8cb8fd0ae08a1a23144db4f3e23178673.tar.gz
Fix sphinx warnings during doc build. (#4795)
-rw-r--r--doc/developer/new_contributor_faq.rst1
-rw-r--r--doc/developer/projects.rst2
-rw-r--r--doc/developer/release.rst8
3 files changed, 6 insertions, 5 deletions
diff --git a/doc/developer/new_contributor_faq.rst b/doc/developer/new_contributor_faq.rst
index 3dc6de35..aa6d1b93 100644
--- a/doc/developer/new_contributor_faq.rst
+++ b/doc/developer/new_contributor_faq.rst
@@ -23,6 +23,7 @@ documentation.
The "best" way to find a place to start is to follow your own personal
interests!
That said, a few places to check for ideas on where to get started:
+
- `The issue tracker <https://github.com/networkx/networkx/issues>`_ lists
known bugs and feature requests. Of particular interest for first-time
contributors are issues that have been tagged with the `Good First Issue`_
diff --git a/doc/developer/projects.rst b/doc/developer/projects.rst
index 14bedef5..e778f418 100644
--- a/doc/developer/projects.rst
+++ b/doc/developer/projects.rst
@@ -76,7 +76,7 @@ Directed Version of Traveling Salesman Problem
The goal of this project is to learn the API used for implemented methods
and then implement the Asadpour method for directed graphs with similar API.
Other even more recent papers discussing algorithm improvements for directed
- TSP (also called Asymmetric TSP or ATSP) include `Svensson`__ and `Traub`__.
+ TSP (also called Asymmetric TSP or ATSP) include `Svensson`_ and `Traub`_.
The Traub paper may be most useful for implementing the algorithm as all three
are focused on proving asymptotic computation requirements rather than coding.
diff --git a/doc/developer/release.rst b/doc/developer/release.rst
index f5f617eb..1dea8dab 100644
--- a/doc/developer/release.rst
+++ b/doc/developer/release.rst
@@ -87,10 +87,10 @@ Release Process
- Update ``major`` and ``minor`` in ``networkx/release.py``.
- Append the following to ``doc/_templates/layout.html``::
- {% block document %}
- {% include "dev_banner.html" %}
- {{ super() }}
- {% endblock %}
+ {% block document %}
+ {% include "dev_banner.html" %}
+ {{ super() }}
+ {% endblock %}
- Commit and push changes::