Move docs to source directory

jdillard · Feb 27, 2023 · adac9bb · adac9bb
1 parent 7ec6ccc
commit adac9bb
Show file tree

Hide file tree

Showing 12 changed files with 34 additions and 19 deletions.
diff --git a/docs/Makefile b/docs/Makefile
@@ -4,8 +4,8 @@
 # You can set these variables from the command line.
 SPHINXOPTS    =
 SPHINXBUILD   = sphinx-build
-SPHINXPROJ    = SphinxCopybutton
-SOURCEDIR     = .
+SPHINXPROJ    = SphinxSitemap
+SOURCEDIR     = source
 BUILDDIR      = _build
 
 # Put it first so that "make" without argument is like "make help".

diff --git a/docs/changelog.rst b/docs/changelog.rst
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -3,3 +3,4 @@ sphinx-contributors
 sphinx
 sphinx-sitemap
 sphinxemoji
+sphinxext-opengraph
diff --git a/docs/_static/sitemap-icon.svg → docs/source/_static/sitemap-icon.svg b/docs/_static/sitemap-icon.svg → docs/source/_static/sitemap-icon.svg
diff --git a/docs/advanced-configuration.rst → docs/source/advanced-configuration.rst b/docs/advanced-configuration.rst → docs/source/advanced-configuration.rst
diff --git a/docs/source/changelog.rst b/docs/source/changelog.rst
@@ -0,0 +1 @@
+.. include:: ../../CHANGELOG.rst
diff --git a/docs/conf.py → docs/source/conf.py b/docs/conf.py → docs/source/conf.py
@@ -45,6 +45,7 @@
     "sphinxemoji.sphinxemoji",
     "sphinx_contributors",
     "sphinx.ext.intersphinx",
+    "sphinxext.opengraph",
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -99,6 +100,9 @@
 html_logo = "_static/sitemap-icon.svg"
 html_title = "Sphinx Sitemap"
 
+ogp_site_url = "https://sphinx-sitemap.readthedocs.io/"
+ogp_image = "https://sphinx-sitemap.readthedocs.io/en/latest/_static/sitemap-icon.svg"
+
 # Custom sidebar templates, must be a dictionary that maps document names
 # to template names.
 #

diff --git a/docs/configuration-values.rst → docs/source/configuration-values.rst b/docs/configuration-values.rst → docs/source/configuration-values.rst
@@ -1,7 +1,13 @@
 Project Configuration Values
 ============================
 
-A list of possible configuration values to configure in **conf.py**:
+A list of of possible configuration values to configure in **conf.py**:
+
+Another line to :math:`test two two`
+
+.. math::
+
+   test two two
 
 .. confval:: sitemap_url_scheme
 
@@ -13,7 +19,7 @@ A list of possible configuration values to configure in **conf.py**:
 
 .. confval:: sitemap_filename
 
-   The filename used for the sitemap. Default is ``sitemap.xml``.
+   The filename used for the the sitemap. Default is ``sitemap.xml``.
 
    See :ref:`configuration_changing_filename` for more information.
 
@@ -24,5 +30,5 @@ A list of possible configuration values to configure in **conf.py**:
    The list of locales to include in the sitemap.
 
    See :ref:`configuration_supporting_multiple_languages` for more information.
-   
+
    .. versionadded:: 2.2.0
diff --git a/docs/contributing.rst → docs/source/contributing.rst b/docs/contributing.rst → docs/source/contributing.rst
@@ -63,8 +63,8 @@ Thanks to all who have contributed!
 The people that have improved the code:
 
 .. contributors:: jdillard/sphinx-sitemap
-    :avatars:
-    :order: ASC
+   :avatars:
+   :order: ASC
 
 
 .. _sphinx-sitemap repository: https://github.com/jdillard/sphinx-sitemap

diff --git a/docs/getting-started.rst → docs/source/getting-started.rst b/docs/getting-started.rst → docs/source/getting-started.rst
@@ -4,28 +4,32 @@ Getting Started
 Installation
 ------------
 
-Directly install via ``pip`` by using::
+Directly install via ``pip`` by using:
 
-    pip install sphinx-sitemap
+.. code::
 
-Or with ``conda`` via ``conda-forge``::
+   pip install sphinx-sitemap
 
-    conda install -c conda-forge sphinx-sitemap
+Or with ``conda`` via ``conda-forge``:
+
+.. code::
+
+   conda install -c conda-forge sphinx-sitemap
 
 Usage
 -----
 
 Add ``sphinx_sitemap`` to :confval:`extensions` in your Sphinx **conf.py**.
 For example:
 
-.. code-block:: python
+.. code:: python
 
    extensions = ['sphinx_sitemap']
 
 Set the value of :confval:`html_baseurl` in your Sphinx **conf.py** to the current
 base URL of your documentation. For example:
 
-.. code-block:: python
+.. code:: python
 
    html_baseurl = 'https://my-site.com/docs/'
 

diff --git a/docs/index.rst → docs/source/index.rst b/docs/index.rst → docs/source/index.rst
@@ -1,12 +1,12 @@
-Sphinx-sitemap
+sphinx-sitemap
 ==============
 
-|PyPI version| |Conda Forge| |Downloads| |Parallel Safe| |GitHub Stars|
-
 A `Sphinx`_ extension to generate multi-version and multi-language
 `sitemaps.org`_ compliant sitemaps for the HTML version of your Sphinx
 documentation.
 
+|PyPI version| |Conda Forge| |Downloads| |Parallel Safe| |GitHub Stars|
+
 .. toctree::
    :maxdepth: 2
 

diff --git a/docs/search-optimization.rst → docs/source/search-optimization.rst b/docs/search-optimization.rst → docs/source/search-optimization.rst
@@ -7,7 +7,7 @@ Search Engine Optimization
 Using robots.txt
 ^^^^^^^^^^^^^^^^
 
-Add a **robots.txt** file in the **source** directory which contains a link to the **sitemap.xml** or **sitemapindex.xml** file. For example::
+Add a **robots.txt** file in the **source** directory which has a link to the ``sitemap.xml`` or ``sitemapindex.xml`` file. For example::
 
   User-agent: *
 
@@ -22,7 +22,7 @@ Then, add **robots.txt** to :confval:`html_extra_path` in **conf.py**:
 Submit Sitemap to Search Engines
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-Submit the **sitemap.xml** or **sitemapindex.xml** to the appropriate search engine tools.
+Submit the ``sitemap.xml`` or ``sitemapindex.xml`` to the appropriate search engine tools.
 
 Site Search Optimization
 ------------------------