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

Question: How do you create the GitHub pages? #39

Open
saguileran opened this issue Oct 16, 2024 · 3 comments
Open

Question: How do you create the GitHub pages? #39

saguileran opened this issue Oct 16, 2024 · 3 comments
Assignees
Labels
type: question Further information is requested type: user help

Comments

@saguileran
Copy link

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 nilomr self-assigned this Oct 16, 2024
@nilomr nilomr added the type: question Further information is requested label Oct 16, 2024
@nilomr
Copy link
Owner

nilomr commented Oct 16, 2024

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
Copy link
Author

Awesome!

Thank you for all the information.

@NickleDave
Copy link

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

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 😕

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: question Further information is requested type: user help
Projects
None yet
Development

No branches or pull requests

3 participants