Skip to content

[MRG] DOC: Fixes for latest numpydoc#13670

Merged
NicolasHug merged 2 commits intoscikit-learn:masterfrom
larsoner:fix-doc
Apr 22, 2019
Merged

[MRG] DOC: Fixes for latest numpydoc#13670
NicolasHug merged 2 commits intoscikit-learn:masterfrom
larsoner:fix-doc

Conversation

@larsoner
Copy link
Copy Markdown
Contributor

@larsoner larsoner commented Apr 18, 2019 •
edited
Loading

What does this implement/fix? Explain your changes.

Fixes:

  1. Warnings about a few files missing from toctrees with :orphan:
  2. Errors in See also blocks due to latest numpydoc getting more strict.
  3. Bump to latest numpydoc

cc @jnothman

jnothman
jnothman reviewed Apr 19, 2019
View reviewed changes
doc/governance.rst Outdated
@@ -1,3 +1,4 @@
:orphan:
Copy link
Copy Markdown
Member

@jnothman jnothman Apr 19, 2019

Choose a reason for hiding this comment

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

I think these should rather be added to our Sphinx TOC. Thanks for catching them!!

Copy link
Copy Markdown
Contributor Author

@larsoner larsoner Apr 21, 2019

Choose a reason for hiding this comment

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

At least the roadmap is already linked from the main page already. I'll remove these for now and someone can link in a follow-up PR so that this can go in. Numpydoc 0.9.0 was just released so the other stuff below will be problematic

@larsoner
Copy link
Copy Markdown
Contributor Author

larsoner commented Apr 19, 2019

I'm out of my depth on this, do you just want to push to my branch? Or I can remove the orphan tags and leave the see also fixes.

@larsoner
Copy link
Copy Markdown
Contributor Author

larsoner commented Apr 19, 2019

(FWIW this is why for SciPy and other projects I've started building with -nWT --keep-going. But it's a bit of work to get to the state that actually works.)

@larsoner
Copy link
Copy Markdown
Contributor Author

larsoner commented Apr 21, 2019

I included a bump to the latest numpydoc, but I can revert that it if it's controversial.

@larsoner
Copy link
Copy Markdown
Contributor Author

larsoner commented Apr 21, 2019

Link: https://55548-843222-gh.circle-artifacts.com/0/doc/index.html

@jnothman jnothman added this to the 0.21 milestone Apr 21, 2019
@larsoner larsoner changed the title DOC: Fixes for latest numpydoc [MRG] DOC: Fixes for latest numpydoc Apr 22, 2019
@NicolasHug NicolasHug merged commit badaa15 into scikit-learn:master Apr 22, 2019
@NicolasHug
Copy link
Copy Markdown
Member

NicolasHug commented Apr 22, 2019

Thanks @larsoner

@larsoner larsoner deleted the fix-doc branch April 22, 2019 21:41
css459 pushed a commit to nyu-ossd-s19/scikit-learn that referenced this pull request Apr 24, 2019
@larsoner @css-nyu
DOC: Fixes for latest numpydoc (scikit-learn#13670)
530749a
jeremiedbb pushed a commit to jeremiedbb/scikit-learn that referenced this pull request Apr 25, 2019
@larsoner @jeremiedbb
DOC: Fixes for latest numpydoc (scikit-learn#13670)
e5a8e0b
xhluca pushed a commit to xhluca/scikit-learn that referenced this pull request Apr 28, 2019
@larsoner
DOC: Fixes for latest numpydoc (scikit-learn#13670)
c4de7d7
xhluca pushed a commit to xhluca/scikit-learn that referenced this pull request Apr 28, 2019
Revert "DOC: Fixes for latest numpydoc (scikit-learn#13670)"
a6f15c8 
This reverts commit c4de7d7.
xhluca pushed a commit to xhluca/scikit-learn that referenced this pull request Apr 28, 2019
Revert "DOC: Fixes for latest numpydoc (scikit-learn#13670)"
0886522 
This reverts commit c4de7d7.
koenvandevelde pushed a commit to koenvandevelde/scikit-learn that referenced this pull request Jul 12, 2019
@larsoner @koenvandevelde
DOC: Fixes for latest numpydoc (scikit-learn#13670)
af65b93
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@jnothman jnothman jnothman approved these changes

+1 more reviewer

@NicolasHug NicolasHug NicolasHug approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

0.21

Development

Successfully merging this pull request may close these issues.

3 participants

@larsoner @NicolasHug @jnothman