Skip to content

adding simple docs site #54

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

Merged
merged 5 commits into from
Nov 18, 2019
Merged

Conversation

choldgraf
Copy link
Collaborator

@choldgraf choldgraf commented Nov 5, 2019

I got tired of being unable to preview the docs locally and also waiting for circleci to build our live preview, so this PR adds a simple "demo docs" site and uses that for the live preview instead of the full pandas documentation.

Right now, it's mostly a copypasta from the readthedocs theme docs. Importantly, that has a bunch of sections that cover different structural / page elements. I haven't modified anything yet, because I think a reasonable first goal should be "the pandas sphinx theme should produce a good-looking website using the readthedocs theme site".

I didn't delete the pandas docs here, because I wasn't sure whether or not it was important to keep it. Happy to do that if you think it's fine.

What do you think?

@choldgraf choldgraf force-pushed the demo-site branch 2 times, most recently from 04fbf12 to 66a4a6e Compare November 5, 2019 02:12
@choldgraf
Copy link
Collaborator Author

Here's the demo link:

https://30-130237506-gh.circle-artifacts.com/0/html/index.html

It has a lot of structural elements missing but I think those will be fixed once #50 lands

FWIW, the docs preview build on Circle now takes about 30 seconds compared with ~9 minutes before :-)

@jorisvandenbossche
Copy link
Member

Cool, thanks!

Some elements that are important for pandas to have in the demo site:

  • rendering of a numpydoc docstring (but it doesn't need to be that many as now, a single one should be enough :-))
  • autosummary tables (we had some problems with rendering of those, and some specific fixes for it)
  • 2 levels in the left sidebar

Some elements that are not important to keep:

  • the huge amount of pages ;)
  • the ipython directive usage (in the end this just produces code-blocks, so shouldn't impact the styling itself)

There might also be some content to take from http://ryan-roemer.github.io/sphinx-bootstrap-theme/README.html

@choldgraf
Copy link
Collaborator Author

choldgraf commented Nov 6, 2019

Thanks for the feedback, I just added the following:

  • Make it so that the top navbar items are much less-cluttered, now there's just a "demo" section at the top.
  • Add an autosummary and automodule demo for some Pandas modules to the "API" section of the demo site. (https://38-130237506-gh.circle-artifacts.com/0/html/demo/api.html)
  • Rebased on master so we can preview the site :-)

How does that look?

@jorisvandenbossche
Copy link
Member

I removed some irrelevant content (eg how to configure the rtd theme, this is not applicable for us (yet)).

And it builds blazingly fast now here. While I am typing his comment it already finished and updated the link ;)

@choldgraf
Copy link
Collaborator Author

Nice! That sounds great to me.

For this PR, do you think we should also remove the pandas documentation from the repository? Or do you need that in there for testing etc? Either way, I'm happy to merge whenever you're happy

@jorisvandenbossche jorisvandenbossche merged commit 4620240 into pydata:master Nov 18, 2019
@jorisvandenbossche
Copy link
Member

Let's keep the pandas docs one for a bit longer, it makes it a bit easier for us to experiment with something pandas specific. But so you can ignore them :)

Thanks for the PR!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants