From 34f0ea05245877c26ce47932cf29000229b61f5f Mon Sep 17 00:00:00 2001 From: Jean-Paul Calderone <exarkun@twistedmatrix.com> Date: Mon, 10 Jun 2019 15:17:24 -0400 Subject: [PATCH] get the top-level docs into the other docs --- code_of_conduct.md => code_of_conduct.rst | 21 +++++++-------------- docs/source/CONTRIBUTING.rst | 1 + docs/source/code_of_conduct.rst | 1 + docs/source/index.rst | 3 ++- 4 files changed, 11 insertions(+), 15 deletions(-) rename code_of_conduct.md => code_of_conduct.rst (78%) create mode 100644 docs/source/CONTRIBUTING.rst create mode 100644 docs/source/code_of_conduct.rst diff --git a/code_of_conduct.md b/code_of_conduct.rst similarity index 78% rename from code_of_conduct.md rename to code_of_conduct.rst index 11f06d9..a80acf6 100644 --- a/code_of_conduct.md +++ b/code_of_conduct.rst @@ -1,4 +1,5 @@ -# Contributor Code of Conduct +Contributor Code of Conduct +=========================== As contributors and maintainers of this project, and in the interest of fostering an open and welcoming community, we pledge to respect all people who @@ -41,17 +42,9 @@ is deemed necessary and appropriate to the circumstances. Maintainers are obligated to maintain confidentiality with regard to the reporter of an incident. -You may send reports to [our Conduct email](mailto:conduct@privatestorage.io). +You may send reports to `our Conduct email <mailto:conduct@privatestorage.io>`_. -If you wish to contact specific maintainers directly, the following have made -themselves available for conduct issues: - -- Jean-Paul Calderone (jean-paul@privatestorage.io) - - -This Code of Conduct is adapted from the [Contributor Covenant][homepage], -version 1.3.0, available at -[http://contributor-covenant.org/version/1/3/0/][version] and the Twisted code of conduct. - -[homepage]: https://contributor-covenant.org/ -[version]: https://contributor-covenant.org/version/1/3/0/ +This Code of Conduct is adapted from the +`Contributor Covenant homepage <https://contributor-covenant.org/>`_, +`version 1.3.0 <https://contributor-covenant.org/version/1/3/0/>`_, +and the Twisted code of conduct. diff --git a/docs/source/CONTRIBUTING.rst b/docs/source/CONTRIBUTING.rst new file mode 100644 index 0000000..fe245d9 --- /dev/null +++ b/docs/source/CONTRIBUTING.rst @@ -0,0 +1 @@ +.. include:: ../../CONTRIBUTING diff --git a/docs/source/code_of_conduct.rst b/docs/source/code_of_conduct.rst new file mode 100644 index 0000000..9861d10 --- /dev/null +++ b/docs/source/code_of_conduct.rst @@ -0,0 +1 @@ +.. include:: ../../code_of_conduct.rst diff --git a/docs/source/index.rst b/docs/source/index.rst index 2dfc798..fd3924b 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -10,7 +10,8 @@ Welcome to Secure Access Token Authorizer's documentation! :maxdepth: 2 :caption: Contents: - + code_of_conduct + CONTRIBUTING Indices and tables ================== -- GitLab