Question: How do you create the GitHub pages?

[saguileran]

You get awesome webpages for the package.

I would like to ask, how do you do those pages? What libraries do you use and how you build them?

Awesome work!

[nilomr]

Hi Sebastián, thanks so much!

I built these docs using MyST, a Markdown 'flavour' for Sphinx (Sphinx docs). For an example, check this guide. I also played around with CSS until I got the look I wanted. You can see all the code for it here.

For the dataset, I created this simple site. I wrote the landing page from scratch I think, (HTML/CSS/a bit of JS), and built the docs part using MkDocs with a customised theme (here). The code for this site is available here.

Feel free to reuse anything you like!!

Nilo

[saguileran]

Awesome!

Thank you for all the information.

[NickleDave]

Hope it's ok if I chime in: @saguileran you might find these guides helpful too:

• https://www.pyopensci.org/python-package-guide/documentation/index.html
• https://learn.scientific-python.org/development/tutorials/docs/

Strongly recommend you use MyST as @nilomr is doing. mkdocs is really nice but MyST + Sphinx is what a majority of the scientific python ecosystem uses so you will benefit from all the prior work there. Sphinx also makes it really easy to cross-reference your actual code (which I am ashamed to say I did not learn until, like, last year 🙈 ) and importantly lets you link to other Python packages through intersphinx. It's also very worth learning how to use sphinx's autodoc and autosummary although IME the right way is non-obvious and you just have to stare at how other projects do it ☹️

Again, hope it's ok that I comment. Not trying to sound like a know it all! Just hoping to save you from learning things the hard way like I had to 😕