Suppressed autolabel-caused warnings with note

anaconda · Apr 3, 2024 · 110f625 · 110f625
1 parent 3f22c86
commit 110f625
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 5 deletions.
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -206,6 +206,13 @@
         ], 
 }
 
+# Suppresses build warnings caused by more than one header having the same name
+# Note: This suppression and the sphinx.ext.autosectionlabel extension should
+# be removed if sections with the same header ever need to be referred to by label.
+# Or the same header labels should be rewritten to not be the same.
+
+suppress_warnings = ['autosectionlabel.*']
+
 # Additional templates that should be rendered to pages, maps page names to
 # template names.
 #

diff --git a/docs/source/config.rst b/docs/source/config.rst
@@ -1,5 +1,3 @@
-.. _Configuration:
-
 =============
 Configuration
 =============

diff --git a/docs/source/user-guide/concepts.rst b/docs/source/user-guide/concepts.rst
@@ -10,7 +10,7 @@ Concepts
 
 
 Project
-========
+=======
 
 A project is a folder that contains an ``anaconda-project.yml``
 configuration file together with scripts, notebooks and other
@@ -38,7 +38,7 @@ command---``anaconda-project run``.
 
 
 Configuration files
-====================
+===================
 
 Projects are affected by 3 configuration files:
 
@@ -84,7 +84,7 @@ into your script, which can be a security risk.
 
 
 Comparing Project to conda env and environment.yml
-===================================================
+==================================================
 
 Project has similar functionality to the ``conda env`` command
 and the ``environment.yml`` file, but it may be more convenient.