Skip to content

Commit 7ebe5c8

Browse files
authored
Create CODE_OF_CONDUCT.md (#562)
* Create CODE_OF_CONDUCT.md * Point to the RTD code of conduct * Docs: Add intersphinx * Docs: add link to our code of conduct * Add missing sphinx link
1 parent 04520a0 commit 7ebe5c8

File tree

3 files changed

+24
-8
lines changed

3 files changed

+24
-8
lines changed

.github/CODE_OF_CONDUCT.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Code of Conduct
2+
3+
A copy of our code of conduct can be found on Read the Docs as seen below.
4+
5+
http://docs.readthedocs.io/en/latest/code-of-conduct.html

docs/conf.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@
3333
# Add any Sphinx extension module names here, as strings. They can be extensions
3434
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
3535
extensions = [
36+
'sphinx.ext.intersphinx',
3637
'sphinx.ext.autodoc',
3738
'sphinx.ext.mathjax',
3839
'sphinx.ext.viewcode',
@@ -101,6 +102,8 @@
101102
# A list of ignored prefixes for module index sorting.
102103
#modindex_common_prefix = []
103104

105+
intersphinx_mapping = {'rtd': ('https://docs.readthedocs.io/en/latest/', None)}
106+
104107

105108
# -- Options for HTML output ---------------------------------------------------
106109

docs/contributing.rst

Lines changed: 16 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,11 @@ for changes, rebuild the sphinx demo docs and build a distributable version of t
1010
The bad news is this means you'll need to set up your environment similar to that
1111
of a front-end developer (vs. that of a python developer). That means installing node and ruby.
1212

13+
.. seealso::
14+
15+
If you are unsure of approptiate actions to take while interacting with our
16+
communinty please read our :doc:`Code of Conduct <rtd:/code-of-conduct>`.
17+
1318

1419
Set up your environment
1520
=======================
@@ -54,24 +59,27 @@ This default task will do the following **very cool things that make it worth th
5459
#. Rebuild the sphinx docs anytime it notices a change to ``.rst``, ``.html``, ``.js``
5560
or ``.css`` files.
5661

62+
.. _bower: http://www.bower.io
63+
.. _sass: http://www.sass-lang.com
64+
.. _wyrm: http://www.github.com/snide/wyrm/
65+
.. _grunt: http://www.gruntjs.com
66+
.. _node: http://www.nodejs.com
67+
.. _sphinx: http://www.sphinx-doc.org/en/stable/
68+
5769

5870
Releasing the Theme
5971
===================
6072

6173
When you release a new version,
6274
you should do the following:
6375

64-
#. Bump the version in ``sphinx_rtd_theme/__init__.py`` – we try to follow `semver <http://semver.org/>`_, so be careful with breaking changes.
76+
#. Bump the version in ``sphinx_rtd_theme/__init__.py`` --
77+
we try to follow `semver <http://semver.org/>`_, so be careful with breaking changes.
6578
#. Run a ``grunt build`` to rebuild all the theme assets.
6679
#. Commit that change.
6780
#. Tag the release in git: ``git tag $NEW_VERSION``.
6881
#. Push the tag to GitHub: ``git push --tags origin``.
6982
#. Upload the package to PyPI: ``python setup.py sdist bdist_wheel upload``.
70-
#. In the ``readthedocs.org`` repo, edit the ``bower.json`` file to point at the correct version (``sphinx-rtd-theme": "https://github.com/rtfd/sphinx-rtd-theme.git#$NEW_VERSION"``).
83+
#. In the ``readthedocs.org`` repo, edit the ``bower.json`` file to point at the correct version
84+
(``sphinx-rtd-theme": "https://github.com/rtfd/sphinx-rtd-theme.git#$NEW_VERSION"``).
7185
#. In the ``readthedocs.org`` repo, run ``gulp build`` to update the distributed theme files.
72-
73-
.. _bower: http://www.bower.io
74-
.. _sass: http://www.sass-lang.com
75-
.. _wyrm: http://www.github.com/snide/wyrm/
76-
.. _grunt: http://www.gruntjs.com
77-
.. _node: http://www.nodejs.com

0 commit comments

Comments
 (0)