From 7da7187c2a0961fa9f05fc90a90170f221011d89 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jelmer=20Vernoo=C4=B3?= Date: Sun, 18 Nov 2018 19:13:41 +0000 Subject: [PATCH] Convert CONTRIBUTING and README to rst. --- CONTRIBUTING.md => CONTRIBUTING.rst | 3 ++- README.md => README.rst | 24 ++++++++++++------------ 2 files changed, 14 insertions(+), 13 deletions(-) rename CONTRIBUTING.md => CONTRIBUTING.rst (99%) rename README.md => README.rst (75%) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.rst similarity index 99% rename from CONTRIBUTING.md rename to CONTRIBUTING.rst index 14a271ea6..d9da2334f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.rst @@ -23,7 +23,8 @@ Running the tests To run the testsuite, you should be able to simply run "make check". This will run the tests using unittest. - $ make check +:: + $ make check Tox configuration is also present as well as a Travis configuration file. diff --git a/README.md b/README.rst similarity index 75% rename from README.md rename to README.rst index 8b99b8ec8..736958989 100644 --- a/README.md +++ b/README.rst @@ -6,7 +6,7 @@ This is the Dulwich project. It aims to provide an interface to git repos (both local and remote) that doesn't call out to git directly but instead uses pure Python. -**Main website**: [www.dulwich.io](https://www.dulwich.io/) +**Main website**: **License**: Apache License, version 2 or GNU General Public License, version 2 or later. @@ -29,7 +29,7 @@ or if you are installing from pip:: $ pip install dulwich --global-option="--pure" Note that you can also specify --global-option in a -[requirements.txt](https://pip.pypa.io/en/stable/reference/pip_install/#requirement-specifiers) +`requirements.txt `_ file, e.g. like this:: dulwich --global-option=--pure @@ -40,7 +40,7 @@ Getting started Dulwich comes with both a lower-level API and higher-level plumbing ("porcelain"). For example, to use the lower level API to access the commit message of the -last commit: +last commit:: >>> from dulwich.repo import Repo >>> r = Repo('.') @@ -52,7 +52,7 @@ last commit: >>> c.message 'Add note about encoding.\n' -And to print it using porcelain: +And to print it using porcelain:: >>> from dulwich import porcelain >>> porcelain.log('.', max_entries=1) @@ -67,26 +67,26 @@ Further documentation --------------------- The dulwich documentation can be found in docs/ and -[on the web](https://www.dulwich.io/docs/). +`on the web `_. The API reference can be generated using pydoctor, by running "make pydoctor", -or [on the web](https://www.dulwich.io/apidocs). +or `on the web `_. Help ---- -There is a *#dulwich* IRC channel on the [Freenode](https://www.freenode.net/), and -[dulwich-announce](https://groups.google.com/forum/#!forum/dulwich-announce) -and [dulwich-discuss](https://groups.google.com/forum/#!forum/dulwich-discuss) +There is a *#dulwich* IRC channel on the `Freenode `_, and +`dulwich-announce `_ +and `dulwich-discuss `_ mailing lists. Contributing ------------ -For a full list of contributors, see the git logs or [AUTHORS](AUTHORS). +For a full list of contributors, see the git logs or `AUTHORS `_. -If you'd like to contribute to Dulwich, see the [CONTRIBUTING](CONTRIBUTING.md) -file and [list of open issues](https://github.com/dulwich/dulwich/issues). +If you'd like to contribute to Dulwich, see the `CONTRIBUTING `_ +file and `list of open issues `_. Supported versions of Python ----------------------------