Commit Graph

33 Commits

Author SHA1 Message Date
Julian Berman
b96d228735 Minor typo in the contributing info 2020-12-16 12:09:17 -05:00
Takeshi KOMIYA
12696cdfa2 doc: Fix URL 2020-06-27 22:19:05 +09:00
Stephen Finucane
6b480c97b2 docs: Rework contributing document, re-add CONTRIBUTING
Reorder this to flow a little better and re-add the CONTRIBUTING
document, which now simply points to the main documentation.

Signed-off-by: Stephen Finucane <stephen@that.guru>
2020-06-02 12:10:21 +01:00
Stephen Finucane
d3021f644f 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>
2020-06-02 12:08:34 +01:00
Stephen Finucane
a33483f154 docs: Add release process document
This is based on content extracted from the CONTRIBUTING document.

Signed-off-by: Stephen Finucane <stephen@that.guru>
2020-06-02 11:43:44 +01:00
Stephen Finucane
6b19678253 docs: Add organization overview
Provide an introduction to how the Sphinx team is organized. This will
be expanded upon in a future change.

Signed-off-by: Stephen Finucane <stephen@that.guru>
2020-06-02 11:43:44 +01:00
Takeshi KOMIYA
bdeea0723b Update CONTRIBUTING 2020-03-28 22:37:22 +09:00
Daniel Hahler
ec7567ce41 Improve documentation about Sphinx's deprecation warnings 2020-03-15 19:20:55 +01:00
Takeshi KOMIYA
f8eb830450 Renaming stable branch to A.x 2020-02-09 20:28:23 +09:00
Bingyao Liu
ec2ee2f7a0 docs: Update invalid file path of configuration.rst in devguide 2019-06-09 21:45:40 +08:00
Takeshi KOMIYA
d6063ff35b doc: Fold lines by 80 columns 2019-05-30 01:07:05 +09:00
shimizukawa
fbff6fc2e2 Update deprecation policy by review. 2019-01-13 16:01:10 +09:00
shimizukawa
f29ea2bcff Update deprecation policy by semantic versioning rules 2019-01-12 23:18:06 +09:00
Takeshi KOMIYA
09a8b5e25c doc: quickstart.py has moved 2019-01-07 23:07:48 +09:00
Takeshi KOMIYA
e700532dd1 docs: check_sources.py now becomes flake8 plugin 2019-01-07 23:07:48 +09:00
Timotheus Kampik
5ed3f0ad52 #5186 add contrib doc for JS tests 2018-07-22 20:51:14 +02:00
Takeshi KOMIYA
fb257ac449 docs: mention about branch model (refs: #4398) 2018-02-07 22:14:18 +09:00
Stephen Finucane
7c0723fd46 tests: Remove 'tests/run.py'
This is no longer necessary. One test needs to be modified to deal with
how 'python -m pytest' modifies the PATH.

Signed-off-by: Stephen Finucane <stephen@that.guru>
2017-12-29 13:02:31 +00:00
Stephen Finucane
638e646766 doc: Rework CONTRIBUTING to encourage use of tox
Embrace the tox-ified future. This explicitly asks users to use a
virtualenv to stop them shooting themselves in the foot.

Signed-off-by: Stephen Finucane <stephen@that.guru>
2017-12-19 15:22:14 +00:00
Stephen Finucane
67753b7ce3 Remove 'test-reqs.txt'
We were never really using this file for its specified purpose [1]. Now
that we have everything cleanly organized in 'setup.py', there really
isn't any reason to keep it around. Remove it.

[1] https://caremad.io/posts/2013/07/setup-vs-requirement/

Signed-off-by: Stephen Finucane <stephen@that.guru>
2017-10-10 14:13:09 +01:00
Frank Sachsenheim
990de5799a Adds a note about passing args to pytest. 2017-10-09 22:37:27 +02:00
Frank Sachsenheim
b2959a91c5 Makefile: Adds a target to build docs from the root dir. 2017-10-09 22:37:27 +02:00
Sanjeev Gupta
495d984db3 Update babel URL to new domain
Also update a couple of URLs to HTTPS
2017-05-30 00:43:56 +08:00
Colin Dunklau
a408e5bb2f Fix a trivial typo in CONTRIBUTING.rst 2017-05-23 16:52:17 +02:00
shimizukawa
d497d74370 refs #3458: add sphinx.testing that are moved from /tests directory. 2017-05-14 20:47:15 +09:00
Nick Volynkin
3dee761727 spell "GitHub" the right way 2017-04-19 11:08:36 +07:00
Takeshi KOMIYA
aa6dfb8b41 Merge branch 'stable' 2017-03-18 18:25:50 +09:00
jfbu
ada9aa6b94 Markup in CONTRIBUTING.rst 2017-03-18 09:49:18 +01:00
jfbu
2b929dc27e Fix syntax coloring in CONTRIBUTING.rst 2017-03-18 09:25:48 +01:00
Tormod Landet
a9243276cc Mention style-checks and type-checks in devguide 2017-03-18 09:15:00 +01:00
Tormod Landet
f6661fb0f3 Mention style-checks and type-checks in devguide 2017-03-16 09:35:11 +01:00
shimizukawa
3efd2df99b Reducing README.rst to avoid duplicated information in CONTRIBUTING.rst. 2016-12-18 00:10:40 +09:00
Matthias Geier
a82aebcd7d Add CONTRIBUTING file 2016-12-16 16:52:11 +01:00