psf / black / 962
96%

DEFAULT BRANCH: master
Ran
Jobs 4
Files 8
Run time 22s
Badge
Embed ▾
README BADGES
x

If you need to use a raster PNG badge, change the '.svg' to '.png' in the link

Markdown

Textile

RDoc

HTML

Rst
962

push

travis-ci-com

web-flow 
Refactor docs / Maintenance of docs (#1456)

* Split code style and components documentation

Splits 'the_black_code_style', 'pragmatism', 'blackd',and 'black_primer'
into their own files. The exception being 'the_black_code_style' and
'pragmatism'. They have been merged into one 'the_black_code_style_and_pragmatism'
file.

These changes are being made because the README is becoming very long. And
a README isn't great if it dissuades its reader because of its length.

* Update the doc generation logic and configuration

With the moving of several sections in the README and the renaming of a
few files, 'conf.py' needs to be able to support custom sections.

This commit introduces DocSection which can be used to specify custom
sections of documentation. The information stored in DocSection will be
used by the process_sections function to read, process, and write the section
to CURRENT_DIR.

A large change has been made to the how the docs are prepared to be built.
Instead of just generating the files needed by reading the README, this
has a full chain of operations so custom sections are supported. First,
it reads the README and spits out a list of DocSection objects representing
the sections to be generated by process_sections. This is done since most
of the docs still live in README. Then along with the defined custom_sections
, the process_sections will be begin to process the DocSection objects.
It reads the information it needs to generate the section. Then fetches
the section's contents, calls processors required by the section to process
the section's contents, and finally writes the section to CURRENT_DIR.

This large change is so processing of the documentation can be done just
for the versions hosted on ReadTheDocs.org. An example processor using this
feature is a 'replace_links' processor. It will replace documentation
links that point to the docs hosted on GitHub with links that point to the
version hosted ... (continued)

4520 of 4723 relevant lines covered (95.7%)

2.87 hits per line

Jobs
ID Job ID Ran Files Coverage
1 962.1 (TEST_CMD="pre-commit run --all-files") 0
0.0
 Travis Job 962.1
2 962.2 (TEST_CMD="coverage run -m unittest") 8
95.66
 Travis Job 962.2
3 962.3 (TEST_CMD="coverage run -m unittest") 8
95.66
 Travis Job 962.3
4 962.4 (TEST_CMD="coverage run -m unittest") 8
95.75
 Travis Job 962.4
Source Files on build 962