-
Notifications
You must be signed in to change notification settings - Fork 0
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
use sphinx to build the site? #9
Comments
@rowanc1: I would appreciate hearing your take on this when you have a chance |
The discussion of including publications in #15 and simpeg/community#11 is re-surfacing how we build the site. With the current format, my approach would be to hack together a custom script that parses the bibtex and gives us the associated HTML page, but this is making me wonder if we should look at another static site generator format so that we can produce simpler intermediate files (e.g. markdown or rst). I would be curious to hear thoughts from others. A couple of possibilities from googling around that would still let us bring in a custom format
I would be curious to hear thoughts. |
I vote for sphinx - it keeps the barrier low as the same system is used for the website as is used for the documentation. Nice examples of sphinx-pages in our realm include https://www.pygimli.org/ and https://www.fatiando.org/ (I also started using it for https://emsig.xyz/). |
@jcapriot: you did some work to get the docs template to match the theme on the website. Is that something you think would be easy to port over here? |
Oh yeah! It should be pretty easy. I’ll look into it |
[transferred from simpeg/old-website#23]
It might be helpful to add a page about the weekly meeting, similar to the pangeo weekly meetings page that shows both the upcoming meetings and the notes. As I dug into the code a bit, the overhead right now for generating a new page isn't completely trivial. (It isn't impossible, but still requires a level of comfort with html).
I had a look around the web and both pangeo and fatiando sites nicely apply their own css and use sphinx, which is already familiar to those who contribute to the simpeg and discretize docs. What are peoples' thoughts on building the site from
.rst
or.md
files using sphinx?The text was updated successfully, but these errors were encountered: