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 <stephen@that.guru>
This commit is contained in:
Stephen Finucane 2020-06-02 11:47:27 +01:00
parent a33483f154
commit d3021f644f
7 changed files with 10 additions and 10 deletions

View File

@ -76,7 +76,7 @@ If you wish to install `Sphinx` for development purposes, refer to `the
contributors guide`__. contributors guide`__.
__ https://pypi.org/project/Sphinx/ __ 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 Documentation
============= =============
@ -110,14 +110,14 @@ For information on running tests locally, refer to `the contributors guide`__.
__ https://travis-ci.org/sphinx-doc/sphinx __ https://travis-ci.org/sphinx-doc/sphinx
__ https://ci.appveyor.com/project/sphinxdoc/sphinx __ https://ci.appveyor.com/project/sphinxdoc/sphinx
__ https://circleci.com/gh/sphinx-doc/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 Contributing
============ ============
Refer to `the contributors guide`__. 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 Release signatures
================== ==================

View File

@ -116,12 +116,12 @@
this part of the documentation is for you.{%endtrans%}</p> this part of the documentation is for you.{%endtrans%}</p>
<ul> <ul>
<li>{%trans path=pathto("devguide")%}<a href="{{ path }}">Sphinx Developers Guide</a></li>{%endtrans%} <li>{%trans path=pathto("internals/contributing")%}<a href="{{ path }}">Sphinx Contributorss Guide</a></li>{%endtrans%}
<li>{%trans path=pathto("authors")%}<a href="{{ path }}">Sphinx Authors</a></li>{%endtrans%} <li>{%trans path=pathto("internals/authors")%}<a href="{{ path }}">Sphinx Authors</a></li>{%endtrans%}
</ul> </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 %} {% endblock %}

View File

@ -19,7 +19,6 @@ Sphinx documentation contents
faq faq
glossary glossary
devguide
changes changes
examples examples

View File

@ -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 * There is also the #sphinx-doc IRC channel on `freenode
<https://freenode.net/>`_. <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 Extensions
========== ==========

View File

@ -1 +0,0 @@
.. include:: ../CONTRIBUTING.rst

View File

@ -9,6 +9,7 @@ how to contribute to the project.
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2
contributing
release-process release-process
organization organization
code-of-conduct code-of-conduct