docs: Add contributing document

This completes the migration from the CONTRIBUTING document to the new in-tree contributing guide. The CONTRIBUTING document itself is temporarily removed so that git will correctly mark the document as having been moved. A future change will re-add this document as well as rework the new contributing document. Signed-off-by: Stephen Finucane <[email protected]>
return007 · Jun 2, 2020 · d3021f6 · d3021f6
1 parent a33483f
commit d3021f6
Show file tree

Hide file tree

Showing 7 changed files with 10 additions and 10 deletions.
diff --git a/README.rst b/README.rst
@@ -76,7 +76,7 @@ If you wish to install `Sphinx` for development purposes, refer to `the
 contributors guide`__.
 
 __ https://pypi.org/project/Sphinx/
-__ http://www.sphinx-doc.org/en/master/devguide.html
+__ http://www.sphinx-doc.org/en/master/internals/contributing.html
 
 Documentation
 =============
@@ -110,14 +110,14 @@ For information on running tests locally, refer to `the contributors guide`__.
 __ https://travis-ci.org/sphinx-doc/sphinx
 __ https://ci.appveyor.com/project/sphinxdoc/sphinx
 __ https://circleci.com/gh/sphinx-doc/sphinx
-__ http://www.sphinx-doc.org/en/master/devguide.html
+__ http://www.sphinx-doc.org/en/master/internals/contributing.html
 
 Contributing
 ============
 
 Refer to `the contributors guide`__.
 
-__ http://www.sphinx-doc.org/en/master/devguide.html
+__ http://www.sphinx-doc.org/en/master/internals/contributing.html
 
 Release signatures
 ==================

diff --git a/doc/_templates/index.html b/doc/_templates/index.html
@@ -116,12 +116,12 @@ <h2>{%trans%}Contributor Guide{%endtrans%}</h2>
     this part of the documentation is for you.{%endtrans%}</p>
 
     <ul>
-      <li>{%trans path=pathto("devguide")%}<a href="{{ path }}">Sphinx Developer’s Guide</a></li>{%endtrans%}
-      <li>{%trans path=pathto("authors")%}<a href="{{ path }}">Sphinx Authors</a></li>{%endtrans%}
+      <li>{%trans path=pathto("internals/contributing")%}<a href="{{ path }}">Sphinx Contributors’s Guide</a></li>{%endtrans%}
+      <li>{%trans path=pathto("internals/authors")%}<a href="{{ path }}">Sphinx Authors</a></li>{%endtrans%}
     </ul>
 
-    <h2>{%trans%}Code of Conduct{%endtrans%}</h2>
+  <h2>{%trans%}Code of Conduct{%endtrans%}</h2>
 
-    {%trans path=pathto("code_of_conduct")%}Please adhere to our <a href="{{ path }}">Code of Conduct</a>.{%endtrans%}
+  <p>{%trans path=pathto("code_of_conduct")%}Please adhere to our <a href="{{ path }}">Code of Conduct</a>.{%endtrans%}</p>
 
 {% endblock %}
diff --git a/doc/contents.rst b/doc/contents.rst
@@ -19,7 +19,6 @@ Sphinx documentation contents
 
    faq
    glossary
-   devguide
    changes
    examples
 

diff --git a/doc/develop.rst b/doc/develop.rst
@@ -14,7 +14,8 @@ Sphinx is a maintained by a group of volunteers.  We value every contribution!
 * There is also the #sphinx-doc IRC channel on `freenode
   <https://freenode.net/>`_.
 
-For more about our development process and methods, see the :doc:`devguide`.
+For more about our development process and methods, refer to
+:doc:`/internals/index`.
 
 Extensions
 ==========

diff --git a/doc/devguide.rst b/doc/devguide.rst
diff --git a/CONTRIBUTING.rst → doc/internals/contributing.rst b/CONTRIBUTING.rst → doc/internals/contributing.rst
diff --git a/doc/internals/index.rst b/doc/internals/index.rst
@@ -9,6 +9,7 @@ how to contribute to the project.
 .. toctree::
    :maxdepth: 2
 
+   contributing
    release-process
    organization
    code-of-conduct
-Original file line number
+Diff line change
@@ Expand Up / @@ -19,7 +19,6 @@ Sphinx documentation contents @@
        faq
        glossary
-       devguide
        changes
        examples
@@ Expand Down @@