X Tutup
Skip to content

Add style to api doc; fix capitalization.#7145

Merged
NelleV merged 1 commit intomatplotlib:masterfrom
anntzer:update-api-doc
Sep 21, 2016
Merged

Add style to api doc; fix capitalization.#7145
NelleV merged 1 commit intomatplotlib:masterfrom
anntzer:update-api-doc

Conversation

@anntzer
Copy link
Copy Markdown
Contributor

@anntzer anntzer commented Sep 20, 2016

All other sections use a lowercase title. Also mention legend_handler
in the title for the legend api doc as they are in the same file.

@tacaswell
Copy link
Copy Markdown
Member

Who ever merges this, please backport to v1.5.3-doc

@tacaswell tacaswell added this to the 2.0 (style change major release) milestone Sep 20, 2016
All other sections use a lowercase title.  Also mention `legend_handler`
in the title for the `legend` api doc as they are in the same file.
@NelleV NelleV merged commit 5f352cb into matplotlib:master Sep 21, 2016
@anntzer anntzer deleted the update-api-doc branch September 21, 2016 00:20
@tacaswell
Copy link
Copy Markdown
Member

@NelleV did you do the backport?

@NelleV
Copy link
Copy Markdown
Member

NelleV commented Sep 21, 2016

Yep, I did.
Is there a way to run travis on other branches than master? That's going to be very annoying to fix on my computer, considering I can't built the doc with warnings treated as error.

@tacaswell
Copy link
Copy Markdown
Member

backported to v1.5.3-doc as 5c548e5

@NelleV
Copy link
Copy Markdown
Member

NelleV commented Sep 21, 2016

Hum… sorry. Yes I did the backport, but the documentation built fails. Hence my very unclear previous message…

@tacaswell
Copy link
Copy Markdown
Member

It is very odd that it passed on master, but not on v1.5.3-doc..... I will take a look at this (me and sphinx are getting to know each other too well).

@NelleV
Copy link
Copy Markdown
Member

NelleV commented Sep 21, 2016

In the meantime, I'm doing another attempt at setting up my dev environment to build the sphinx documentation with the same options as on travis. I'll keep posted if I have any luck.

@tacaswell
Copy link
Copy Markdown
Member

The docs build cleanly for me locally, I restarted travis on this branch (accidentally for the full matrix :/)

@tacaswell
Copy link
Copy Markdown
Member

but with python 3.5 + sphinx 1.4.6 not py2.7 + sx1.3.1

@efiring
Copy link
Copy Markdown
Member

efiring commented Sep 21, 2016

@NelleV, doc/make.py has a command-line argument:

parser.add_argument("--allowsphinxwarnings",
                    help="Don't turn Sphinx warnings into errors",
                    action="store_true")

@QuLogic
Copy link
Copy Markdown
Member

QuLogic commented Sep 25, 2016

Docs appear to still not be building.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants

X Tutup