You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* 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
Copy file name to clipboardExpand all lines: docs/contributing.rst
+16-8Lines changed: 16 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,6 +10,11 @@ for changes, rebuild the sphinx demo docs and build a distributable version of t
10
10
The bad news is this means you'll need to set up your environment similar to that
11
11
of a front-end developer (vs. that of a python developer). That means installing node and ruby.
12
12
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
+
13
18
14
19
Set up your environment
15
20
=======================
@@ -54,24 +59,27 @@ This default task will do the following **very cool things that make it worth th
54
59
#. Rebuild the sphinx docs anytime it notices a change to ``.rst``, ``.html``, ``.js``
55
60
or ``.css`` files.
56
61
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
+
57
69
58
70
Releasing the Theme
59
71
===================
60
72
61
73
When you release a new version,
62
74
you should do the following:
63
75
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.
65
78
#. Run a ``grunt build`` to rebuild all the theme assets.
66
79
#. Commit that change.
67
80
#. Tag the release in git: ``git tag $NEW_VERSION``.
68
81
#. Push the tag to GitHub: ``git push --tags origin``.
69
82
#. 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
0 commit comments