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

Doc using pydata-sphinx-theme #440

Merged
merged 2 commits into from
Feb 18, 2022
Merged

Conversation

tupui
Copy link
Contributor

@tupui tupui commented Feb 16, 2022

Part of #438

Note that I already went ahead for the branch name in the links and also the repo address.

The following will be fixed later on with #436

.../rbc/doc/omnisci/array.rst: WARNING: document isn't included in any toctree
.../rbc/doc/omnisci/bytes.rst: WARNING: document isn't included in any toctree
.../rbc/doc/omnisci/column.rst: WARNING: document isn't included in any toctree
.../rbc/doc/omnisci/columnlist.rst: WARNING: document isn't included in any toctree
.../rbc/doc/omnisci/outputcolumn.rst: WARNING: document isn't included in any toctree

@tupui tupui added the documentation Document a feature label Feb 16, 2022
@tupui tupui self-assigned this Feb 16, 2022
Copy link
Contributor

@guilhermeleobas guilhermeleobas left a comment

Choose a reason for hiding this comment

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

LGTM.

Not related to this PR, but I just notice some signatures have the typingctx as first parameter. I need to remove this from showing up in the docs.

image

Copy link
Contributor

@pearu pearu left a comment

Choose a reason for hiding this comment

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

I have a suggestion and a couple of comments. Otherwise, LGTM! Thanks, @tupui!

doc/conf.py Outdated
'sticky_navigation': True,
# 'navigation_depth': 4,
"logo_link": "index",
"github_url": "https://github.com/quansight/rbc",
Copy link
Contributor

Choose a reason for hiding this comment

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

just a note: this does not exist yet

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yeah I will revert this (and bellow for the html_context) quick so we can merge and I can change it as soon as we moved the repo. Same for the logo actually, I suppose we should put Quansight's one once we move.

When we do the move we should also take the opportunity to rename the branch to main. BTW, who is doing this? I don't think I have permissions to help on that.

Copy link
Contributor

Choose a reason for hiding this comment

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

Before moving, let's have one rbc release first.
^ @guilhermeleobas
Re main branch, see #328

Copy link
Contributor Author

@tupui tupui left a comment

Choose a reason for hiding this comment

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

Thanks @pearu!

doc/conf.py Outdated
'sticky_navigation': True,
# 'navigation_depth': 4,
"logo_link": "index",
"github_url": "https://github.com/quansight/rbc",
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yeah I will revert this (and bellow for the html_context) quick so we can merge and I can change it as soon as we moved the repo. Same for the logo actually, I suppose we should put Quansight's one once we move.

When we do the move we should also take the opportunity to rename the branch to main. BTW, who is doing this? I don't think I have permissions to help on that.

@tupui tupui merged commit 320c10d into heavyai:master Feb 18, 2022
@tupui tupui deleted the tupui/pydata_theme branch February 18, 2022 10:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Document a feature
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants