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

Jump to bottom

DOC: fix includes #38839

Merged
merged 1 commit into from
Dec 31, 2020
Merged

DOC: fix includes #38839

merged 1 commit into from
Dec 31, 2020

Conversation

afeld
Copy link
Member

@afeld afeld commented Dec 31, 2020

  • Added missing . to the .. includes
  • Put the includes in a folder to exclude from Sphinx, to avoid :orphan: being written to the HTML

Before:

Screen_Shot_2020-12-30_at_7_08_52_PM

After:

Screen Shot 2020-12-30 at 7 07 41 PM

  • closes #xxxx
  • tests added / passed
  • passes black pandas
  • passes git diff upstream/master -u -- "*.py" | flake8 --diff
  • whatsnew entry

@afeld afeld mentioned this pull request Dec 31, 2020
Merged
5 tasks
@jreback
Copy link
Contributor

jreback commented Dec 31, 2020

small linting error but the doc build passed: https://github.com/pandas-dev/pandas/pull/38839/checks?check_run_id=1628340684

@jreback jreback added the Docs label Dec 31, 2020
jorisvandenbossche
jorisvandenbossche reviewed Dec 31, 2020
View reviewed changes
Copy link
Member

@jorisvandenbossche jorisvandenbossche left a comment

Choose a reason for hiding this comment

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

Thanks!

doc/source/conf.py Outdated Show resolved Hide resolved
doc/source/conf.py Show resolved Hide resolved
@afeld
DOC: fix includes
4aac76c 
- Added missing `.` to the `.. include`s
- Put the includes in a folder to exclude from Sphinx, to avoid
  `:orphan:` being written to the HTML
@jreback jreback added this to the 1.3 milestone Dec 31, 2020
@jreback jreback merged commit 784de76 into pandas-dev:master Dec 31, 2020
@jreback
Copy link
Contributor

jreback commented Dec 31, 2020

thanks @afeld (pls check dev docs for rendered results in a while)

@afeld
Copy link
Member Author

afeld commented Jan 1, 2021

They look good!

luckyvs1 pushed a commit to luckyvs1/pandas that referenced this pull request Jan 20, 2021
@afeld @luckyvs1
DOC: fix includes (pandas-dev#38839)
380dd95
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jorisvandenbossche jorisvandenbossche jorisvandenbossche left review comments

Assignees
No one assigned
Labels
Docs
Projects
None yet
Milestone
1.3
Development

Successfully merging this pull request may close these issues.
3 participants
@afeld @jreback @jorisvandenbossche