sapling/doc
Jun Wu 584656dff3 codemod: join the auto-formatter party
Summary:
Turned on the auto formatter. Ran `arc lint --apply-patches --take BLACK **/*.py`.
Then run `arc lint` again so some other autofixers like spellchecker etc. looked
at the code base. Manually accept the changes whenever they make sense, or use
a workaround (ex. changing "dict()" to "dict constructor") where autofix is false
positive. Disabled linters on files that are hard (i18n/polib.py) to fix, or less
interesting to fix (hgsubversion tests), or cannot be fixed without breaking
OSS build (FBPYTHON4).

Conflicted linters (test-check-module-imports.t, part of test-check-code.t,
test-check-pyflakes.t) are removed or disabled.

Duplicated linters (test-check-pyflakes.t, test-check-pylint.t) are removed.

An issue of the auto-formatter is lines are no longer guarnateed to be <= 80
chars. But that seems less important comparing with the benefit auto-formatter
provides.

As we're here, also remove test-check-py3-compat.t, as it is currently broken
if `PYTHON3=/bin/python3` is set.

Reviewed By: wez, phillco, simpkins, pkaush, singhsrb

Differential Revision: D8173629

fbshipit-source-id: 90e248ae0c5e6eaadbe25520a6ee42d32005621b
2018-05-25 22:17:29 -07:00
..
fb-hgext fb-hgext: move docs 2018-01-10 08:44:04 -08:00
hggit hggit: internalize extension 2018-01-09 06:08:01 -08:00
hgsql hgsql: integrate with hg-crew 2018-01-04 07:22:19 -08:00
hgsubversion hgsuversion: move docs and tools 2018-01-10 16:20:15 -08:00
remotenames remotenames: drop the dir and do some cleanup 2018-01-10 09:01:52 -08:00
check-seclevel.py codemod: join the auto-formatter party 2018-05-25 22:17:29 -07:00
docchecker fb-hgext: fix gendoc-related issues 2018-01-09 03:44:33 -08:00
gendoc.py codemod: join the auto-formatter party 2018-05-25 22:17:29 -07:00
hgmanpage.py codemod: join the auto-formatter party 2018-05-25 22:17:29 -07:00
Makefile build: make install in "/doc" failed if the destination dir contained spaces 2017-10-11 01:19:48 +02:00
README doc/README: simplify instructions 2009-09-03 21:40:45 +02:00
runrst doc: translate from :hg:help config.SECTION to a valid link to hgrc.5.html 2016-02-11 23:15:34 +09:00
style.css urls: bulk-change primary website URLs 2015-09-30 15:43:49 -05:00

Mercurial's documentation is kept in reStructuredText format, which is
a simple plain text format that's easy to read and edit:

  http://docutils.sourceforge.net/rst.html

It's also convertible to a variety of other formats including standard
UNIX man page format and HTML. You'll need to install Docutils:

  http://docutils.sourceforge.net/

Use the Makefile in this directory to generate the man and HTML pages.