[REVIEW] Ignore python docs build artifacts #12000
Conversation
galipremsagar
added
3 - Ready for Review
Codecov ReportBase: 87.40% // Head: 88.15% // Increases project coverage by
Additional details and impacted files@@ Coverage Diff @@
## branch-22.12 #12000 +/- ##
================================================
+ Coverage 87.40% 88.15% +0.74%
================================================
Files 133 133
Lines 21833 21995 +162
================================================
+ Hits 19084 19389 +305
+ Misses 2749 2606 -143
Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. ☔ View full report at Codecov. |
| @@ -165,3 +165,6 @@ dask-worker-space/ | |||
| # Sphinx docs & build artifacts | |||
| docs/cudf/source/api_docs/generated/* | |||
| docs/cudf/source/api_docs/api/* | |||
| docs/cudf/source/user_guide/example_files/* | |||
| docs/cudf/source/user_guide/example_output/* | |||
| docs/cudf/source/user_guide/cudf.*Dtype.*.rst | |||
There was a problem hiding this comment.
What does this rule ignore? Are there generated files / where do they come from?
There was a problem hiding this comment.
There are files generated after the build for every attribute & method:
Grayed-out ones are the build artifacts, I'm trying to gitignore those files.
There was a problem hiding this comment.
@galipremsagar Do you know what script generates those files or how that is defined? This doesn't seem like a Sphinx feature that I'm familiar with.
There was a problem hiding this comment.
That is the expected behavior and happens in all of our sphinx-build. Those files are generated in docs/cudf/source/api_docs/api/ folder because we specify toctree: api/.
The part of code that is responsible for this is everywhere in our code where we do HACK --... in comments for example:
..
HACK -- the point here is that we don't want this to appear in the output, but the autosummary should still generate the pages.
.. autosummary::
:toctree:
{% for item in all_methods %}
{%- if not item.startswith('_') or item in ['__call__'] %}
{{ name }}.{{ item }}
{%- endif -%}
{%- endfor %}
This is basically being done to mimic panadas & generate dedicated html pages for each property and function.
|
Check out this pull request on See visual diffs & provide feedback on Jupyter Notebooks. Powered by ReviewNB |
galipremsagar
added
5 - Ready to Merge
|
@gpucibot merge |
Description
This PR gitignores some of the python docs build artifcats that keep showing up in
git statusChecklist