Skip to content
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.

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

Remove some docs warnings #593

Merged
merged 3 commits into from Apr 8, 2020
Merged

Remove some docs warnings #593

merged 3 commits into from Apr 8, 2020

Conversation

dsherry
Copy link
Collaborator

@dsherry dsherry commented Apr 8, 2020

Fixes warning about missing newline in changelog. Also remove duplicate entry in api docs.

Also fixing the changelog from my last PR #594 , accidentally put that in the 0.8.0 release notes 🤦‍♂️

@dsherry dsherry added documentation Improvements or additions to documentation enhancement An improvement to an existing feature. labels Apr 8, 2020
@dsherry dsherry self-assigned this Apr 8, 2020
@codecov
Copy link

codecov bot commented Apr 8, 2020

Codecov Report

Merging #593 into master will not change coverage by %.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #593   +/-   ##
=======================================
  Coverage   98.87%   98.87%           
=======================================
  Files         118      118           
  Lines        4439     4439           
=======================================
  Hits         4389     4389           
  Misses         50       50           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 7b6c020...99235aa. Read the comment docs.

@dsherry
Copy link
Collaborator Author

dsherry commented Apr 8, 2020

This fixed the changelog warning, but I still see:

/home/docs/checkouts/readthedocs.org/user_builds/feature-labs-inc-evalml/envs/ds_docs_sphinx_fixes/lib/python3.7/site-packages/evalml/pipelines/pipeline_base.py:docstring of evalml.pipelines.PipelineBase.feature_importance_graph:1: WARNING: duplicate object description of evalml.pipelines.PipelineBase.feature_importance_graph, other instance in /home/docs/checkouts/readthedocs.org/user_builds/feature-labs-inc-evalml/checkouts/ds_docs_sphinx_fixes/docs/source/generated/evalml.pipelines.PipelineBase.feature_importance_graph.rst, use :noindex: for one of them
/home/docs/checkouts/readthedocs.org/user_builds/feature-labs-inc-evalml/envs/ds_docs_sphinx_fixes/lib/python3.7/site-packages/evalml/pipelines/pipeline_base.py:docstring of evalml.pipelines.PipelineBase.graph:1: WARNING: duplicate object description of evalml.pipelines.PipelineBase.graph, other instance in /home/docs/checkouts/readthedocs.org/user_builds/feature-labs-inc-evalml/checkouts/ds_docs_sphinx_fixes/docs/source/generated/evalml.pipelines.PipelineBase.graph.rst, use :noindex: for one of them

@dsherry dsherry requested a review from angela97lin Apr 8, 2020
@dsherry dsherry changed the title [WIP] Remove some docs warnings Remove some docs warnings Apr 8, 2020
@@ -36,7 +38,6 @@ Changelog
* Add code style and github issue guides :pr:`463` :pr:`512`
* Updated API reference for to surface class variables for pipelines and components :pr:`537`
* Fixed README documentation link :pr:`535`
* Limit readthedocs formats to html and pdf, not epub :pr:`594`
Copy link
Collaborator Author

@dsherry dsherry Apr 8, 2020

Choose a reason for hiding this comment

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

Oops!

@jeremyliweishih
Copy link
Contributor

jeremyliweishih commented Apr 8, 2020

I still see:

/home/circleci/evalml/evalml/pipelines/pipeline_base.py:docstring of evalml.pipelines.PipelineBase.graph:1: WARNING: duplicate object description of evalml.pipelines.PipelineBase.graph, other instance in /home/circleci/evalml/docs/source/generated/evalml.pipelines.PipelineBase.graph.rst, use :noindex: for one of them

is this PR also supposed to fix that?

@dsherry
Copy link
Collaborator Author

dsherry commented Apr 8, 2020

@jeremyliweishih nah I just wanted to get some fixes in. I wasn't able to figure out those warnings yet, will do in a separate PR

Copy link
Contributor

@jeremyliweishih jeremyliweishih left a comment

LGTM thanks for fixing this up!

Copy link
Contributor

@angela97lin angela97lin left a comment

Yay, this saves me from making the changes on my branches all the time lol, thanks for this!

@dsherry dsherry merged commit 0635980 into master Apr 8, 2020
2 checks passed
@dsherry dsherry deleted the ds_docs_sphinx_fixes branch Apr 8, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement An improvement to an existing feature.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants