Fix Sphinx warnings

Qiskit · Jul 27, 2022 · 0df538f · 0df538f
1 parent 5d1b130
commit 0df538f
Show file tree

Hide file tree

Showing 7 changed files with 11 additions and 9 deletions.
diff --git a/README.md b/README.md
@@ -12,7 +12,7 @@
   - You can see the full rendered docs at:
     <https://qiskit.org/documentation/rustworkx>
 
-:warning: The retworkx project has been renamed to **rustworkx**. The use of the
+|:warning:| The retworkx project has been renamed to **rustworkx**. The use of the
 retworkx package will still work for the time being but starting in the 1.0.0
 release retworkx will no longer be supported
 

diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -38,6 +38,7 @@
               'jupyter_sphinx',
               'reno.sphinxext',
               'sphinx.ext.intersphinx',
+              'sphinxemoji.sphinxemoji',
               'sphinx_reredirects',
              ]
 html_static_path = ['_static']

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -1,6 +1,6 @@
-######################
+#######################
 rustworkx Documentation
-######################
+#######################
 
 .. note::
 

diff --git a/docs/source/networkx.rst b/docs/source/networkx.rst
@@ -1,8 +1,8 @@
 .. _networkx:
 
-###########################
+############################
 rustworkx for NetworkX users
-###########################
+############################
 
 This is an introductory guide for existing `NetworkX <https://networkx.org>`__
 users on how to use rustworkx, how it differs from NetworkX, and key

diff --git a/docs/source/requirements.txt b/docs/source/requirements.txt
@@ -8,3 +8,4 @@ reno>=3.4.0
 qiskit-sphinx-theme>=1.7
 matplotlib>=3.4
 sphinx-reredirects
+sphinxemoji
diff --git a/docs/source/tutorial/index.rst b/docs/source/tutorial/index.rst
@@ -1,6 +1,6 @@
-#############################
+##############################
 rustworkx Tutorials and Guides
-#############################
+##############################
 
 This section contains tutorials on using rustworkx.
 

diff --git a/docs/source/tutorial/introduction.rst b/docs/source/tutorial/introduction.rst
@@ -2,9 +2,9 @@
    introduction tutorial in  NetworkX's documentation which can be found here:
    https://networkx.org/documentation/networkx-2.6.2/tutorial.html
 
-########################
+#########################
 Introduction to rustworkx
-########################
+#########################
 
 This guide serves as an introduction to working with rustworkx. If you're a
 current or past `NetworkX <https:://networkx.org>`__ user who is looking at