Doc move to sphinx #83
Conversation
|
OK, this seems to work. It would be nice to also add circleCI so that we could see the page before it built, but... |
jklymak
force-pushed
the
doc-move-to-sphinx
branch
from
8a50df2 to
3bed939
Compare
|
Is it possible to have cheatsheets side by side instead of top of each other? |
|
Almost certainly, but maybe as a follow up? We have things side-by-side on the main site so I am sure we can figure out how to do that. |
jklymak
force-pushed
the
doc-move-to-sphinx
branch
from
78620c6 to
f773254
Compare
|
Changed the GitHub action to also upload the doc build. This PR would need to be merged before we can see CircleCI (and @tacaswell (or maybe @QuLogic) would have to grant it permission on the circleCI page). |
|
Latest commit makes the page with two and three columns: |
jklymak
force-pushed
the
doc-move-to-sphinx
branch
from
c7cdb4e to
9827dea
Compare
|
I'm not sure if we need to enable anything for Circle; it only triggers from config on the default branch, not PRs. |
|
I'm a little confused about our merge policy on this project. I think the policy should be: changes to the actual cheatsheets @rougier must approve, but changes to the CI and webpage can be done more generally by the Matplotlib team? |
|
@jimustafa Any comments/review on this? You have been doing the bulk of the maintenance here... Thanks! |
|
@jklymak For cheatsheets, I think all the Matpltolib team should be able to approve PR, especially when it's not a big change. For bigger changes, I would be happy to keep an eye of it but nothing mandatory. |
|
@rougier OK, that sounds reasonable; we will be sure to request a review if something is major and/or aesthetic! |
I had a similar question. It seems that the circle config is basically the same as for matplotlib/mpl-brochure-site, and there the documents appear to be built and hosted for PRs. Could one of the checks for PRs here be a review of the built docs hosted on circle? I checked out this PR and was able to build the docs with |
|
|
||
| # -- Project information ----------------------------------------------------- | ||
|
|
||
| html_title = 'Visualization with Python' |
There was a problem hiding this comment.
title -> "Matplotlib Cheatsheets"
There was a problem hiding this comment.
So, the actual title ends up being "Matplotlib Cheatsheets - Visualization with Python" so I think this is OK.
| html_title = 'Visualization with Python' | ||
| project = "Matplotlib cheatsheets" | ||
| copyright = ( | ||
| f"2012 - {datetime.datetime.now().year} The Matplotlib development team" |
There was a problem hiding this comment.
Does the copyright years to be be different for the cheatsheets?
There was a problem hiding this comment.
I guess the appearance is that it should look like the rest of the docs, so the webpage should stay this way. The cheatsheets may of course have their own copyright.
jklymak
force-pushed
the
doc-move-to-sphinx
branch
from
7243ce9 to
bcec3c5
Compare
Well, this was just because my conda env didn't have pyqt5 downloaded, and I realized we probably didn't want the build script to require a GUI framework. |
Yep, that was the plan; there will need to be a circle CI follow up as I'm sure I didn't do it properly, and we should add the action to post the link. |
|
I'm going to merge this and then enable circle (the web UI won't let you enable a repo until it can see a config yaml in the branch you want to run off of). |
|
Yes, circle is definitely broken. Not sure how to install all the deps.... |
This moves the website to sphinx instead of raw html...
Closes #82