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.

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

[REVIEW] Ignore python docs build artifacts #12000

Merged
merged 4 commits into from
Oct 27, 2022
Merged

[REVIEW] Ignore python docs build artifacts #12000

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
e057f9e
Ignore build artifacts
galipremsagar Oct 26, 2022
a05250b
Merge remote-tracking branch 'upstream/branch-22.12' into gitignore
galipremsagar Oct 26, 2022
f3e4ed2
Address reviews
galipremsagar Oct 26, 2022
77b9d6a
Merge branch 'rapidsai:branch-22.12' into gitignore
galipremsagar Oct 27, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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/*
galipremsagar marked this conversation as resolved.
Show resolved Hide resolved
docs/cudf/source/user_guide/example_output/*
docs/cudf/source/user_guide/cudf.*Dtype.*.rst
Copy link
Contributor

Choose a reason for hiding this comment

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

What does this rule ignore? Are there generated files / where do they come from?

Copy link
Contributor Author

@galipremsagar galipremsagar Oct 26, 2022 •
edited
Loading

Choose a reason for hiding this comment

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

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.

Screen Shot 2022-10-26 at 3 59 09 PM

Copy link
Contributor

Choose a reason for hiding this comment

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

@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.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

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.

Copy link
Contributor

Choose a reason for hiding this comment

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

Thanks for the explanation!