Regenerate the gitwash docs. #8137

Merged
merged 1 commit into from Feb 26, 2017

Conversation

Projects
None yet
7 participants
Contributor

aashil commented Feb 23, 2017 edited

Regenerate the gitwash docs and add README.txt documenting how to use the script to generate the docs. Fixes #8123

doc/devel/README.txt
+All documentation in the gitwash directory are automatically generated by running the below script in
+the project's root directory:
+
+python gitwash_dumper.py doc/devel Matplotlib --repo-name=matplotlib --github-user=matplotlib \
@NelleV

NelleV Feb 23, 2017

Contributor

Can you add a link to the gitwash script?

@aashil

aashil Feb 23, 2017

Contributor

I restructured the sentence a bit and added the link to gitwash_dumper.py script. Have a look.

Contributor

NelleV commented Feb 23, 2017

Apart from my comment, it looks good to me.

@NelleV

NelleV approved these changes Feb 23, 2017

NelleV changed the title from Regenerate the gitwash docs. to [MRG+1] Regenerate the gitwash docs. Feb 23, 2017

Member

QuLogic commented Feb 24, 2017

Documentation isn't building:

Warning, treated as error:

/home/travis/build/matplotlib/matplotlib/doc/devel/gitwash/setting_up_for_development.rst:: WARNING: document isn't included in any toctree

Contributor

matthew-brett commented Feb 24, 2017

It looks like the setting_up_for_development page is a version of gitwash's git_development page, and can be deleted.

Member

QuLogic commented Feb 24, 2017

Still more doc errors:

Warning, treated as error:

/home/travis/build/matplotlib/matplotlib/doc/devel/gitwash/dot2_dot3.rst:: WARNING: document isn't included in any toctree

@aashil aashil Regenerate the gitwash docs.
* Add README.txt documenting how to use the script to generate
gitwash docs.
8c57dae
Contributor

aashil commented Feb 25, 2017

Any idea why appveyor and codecov fail?

Member

phobson commented Feb 25, 2017 edited

@aashil they're both kind of finiky. I looks like appveyor had some transient network issues. I restarted its build.

Contributor

dstansby commented Feb 25, 2017

The fancy log bit is over-running the text box quite a bit, does anyone know if there's a way to fix this?
screen shot 2017-02-25 at 12 44 54

Member

QuLogic commented Feb 26, 2017

It's a literal block, so I think the only choice is to pick a shorter set of log lines.

dstansby changed the title from [MRG+1] Regenerate the gitwash docs. to Regenerate the gitwash docs. Feb 26, 2017

@dstansby dstansby merged commit cb0d97c into matplotlib:master Feb 26, 2017

5 checks passed

codecov/patch Coverage not affected when comparing ba418fd...8c57dae
Details
codecov/project/library 57.85% (+<.01%) compared to ba418fd
Details
codecov/project/tests 98.56% (target 97.9%)
Details
continuous-integration/appveyor/pr AppVeyor build succeeded
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details
Contributor

dstansby commented Feb 26, 2017

Not sure if this wants a backport - if anyone else thinks it does feel free to do the backport.

@tacaswell tacaswell added a commit that referenced this pull request Feb 26, 2017

@dstansby @tacaswell dstansby + tacaswell Merge pull request #8137 from aashil/regenerate-gitwash-docs
Regenerate the gitwash docs.
1d87fba
Owner

tacaswell commented Feb 26, 2017

Backported to v2.0.0-doc as 1d87fba

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment