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

use sphinx to build the site? #9

Open
lheagy opened this issue Aug 1, 2019 · 5 comments
Open

use sphinx to build the site? #9

lheagy opened this issue Aug 1, 2019 · 5 comments

Comments

@lheagy
Copy link
Member

lheagy commented Aug 1, 2019

[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?

@lheagy
Copy link
Member Author

lheagy commented Oct 15, 2019

@rowanc1: I would appreciate hearing your take on this when you have a chance

@lheagy
Copy link
Member Author

lheagy commented Jul 7, 2021

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.

@prisae
Copy link
Member

prisae commented Jul 7, 2021

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/).

@lheagy
Copy link
Member Author

lheagy commented Jul 7, 2021

@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?

@jcapriot
Copy link
Member

jcapriot commented Jul 8, 2021

Oh yeah! It should be pretty easy. I’ll look into it

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

No branches or pull requests

3 participants