Skip to content

Regenerate the gitwash docs. #8137

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 1 commit into from
Feb 26, 2017
Merged

Regenerate the gitwash docs. #8137

merged 1 commit into from
Feb 26, 2017

Conversation

aashil
Copy link
Contributor

@aashil aashil commented Feb 23, 2017 •
edited
Loading

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

NelleV
NelleV reviewed Feb 23, 2017
View reviewed changes
doc/devel/README.txt Outdated
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 \
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you add a link to the gitwash script?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

@NelleV
Copy link
Member

NelleV commented Feb 23, 2017

Apart from my comment, it looks good to me.

@NelleV NelleV changed the title Regenerate the gitwash docs. [MRG+1] Regenerate the gitwash docs. Feb 23, 2017
@aashil aashil force-pushed the regenerate-gitwash-docs branch from fe816aa to 3a7aebc Compare February 23, 2017 22:02
@QuLogic
Copy link
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

@matthew-brett
Copy link
Contributor

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

@aashil aashil force-pushed the regenerate-gitwash-docs branch from 3a7aebc to 1b078de Compare February 24, 2017 04:09
@QuLogic
Copy link
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
Regenerate the gitwash docs.
8c57dae 
* Add README.txt documenting how to use the script to generate
gitwash docs.
@aashil aashil force-pushed the regenerate-gitwash-docs branch from 1b078de to 8c57dae Compare February 25, 2017 02:55
@aashil
Copy link
Contributor Author

aashil commented Feb 25, 2017

Any idea why appveyor and codecov fail?

@phobson
Copy link
Member

phobson commented Feb 25, 2017 •
edited
Loading

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

@dstansby
Copy link
Member

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

@QuLogic
Copy link
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 dstansby changed the title [MRG+1] Regenerate the gitwash docs. Regenerate the gitwash docs. Feb 26, 2017
@dstansby dstansby merged commit cb0d97c into matplotlib:master Feb 26, 2017
@dstansby
Copy link
Member

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

tacaswell pushed a commit that referenced this pull request Feb 26, 2017
@dstansby @tacaswell
Merge pull request #8137 from aashil/regenerate-gitwash-docs
1d87fba 
Regenerate the gitwash docs.
@tacaswell
Copy link
Member

Backported to v2.0.0-doc as 1d87fba

@tacaswell tacaswell added this to the 2.0.1 (next bug fix release) milestone Feb 26, 2017
@tacaswell tacaswell mentioned this pull request Jul 10, 2017
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@NelleV NelleV NelleV approved these changes

Assignees
No one assigned
Labels
Documentation
Projects
None yet
Milestone
v2.0.1
Development

Successfully merging this pull request may close these issues.
7 participants
@aashil @NelleV @QuLogic @matthew-brett @phobson @dstansby @tacaswell