astroml / astroml.github.com

astroML web page

astroML web page repository for https://www.astroml.org

Please do not submit pull requests to this repository, but directly to the source code! This repo is just hosting the rendered version of the webpage, the source code for the documentation and figure scripts can be found in the astroML, and astroML_figures repositories, respectively.

To build the website, clone both repos, define the BOOK_FIGURES_PATH env variable to point to the astroML_figures clone, and use make html in the doc directory in the astroML clone.

astroml.github.com's Issues

Update figures for second edition

Set up automated API documentation updates

We don't necessarily need to use readthedocs, but something similar would be nice to make sure we have a rendered, up-to-date version of the API documentation.

Add page for first edition figures

Remove note from fig 8.4 page

remove text http://www.astroml.org/book_figures/chapter8/fig_rbf_ridge_mu_z.html#changes-from-published-version, as now the published version is the right version

Add link to point to the counterpart figure in the other edition

It maybe useful to have a link on each figure's page that points to the same figure in the other edition of the book.

Fix dropdown CSS

There is some ugliness in the dropdown CSS (overflow at the bottom of the box, and some weirdness at the lower part of the text)

Order of double figures may have been mixed up

This PR basically swaps double figures around. Fix 10.3 has been fixed, but the others may be off, too and all has to be double-checked and confirmed to be correct.

86520ea

Run website accessibility checks

E.g. with the chrome extension: lighthouse report, maybe there is a CI action for it, too.

Add links over figure numbers

We have 2, and in some cases 3 versions for the figures. The book editions are available from the drop downs, but it would be best to have way to navigate between the versions on the figure level, too.

E.g. turn the figure number, at top of each page, to a menu of 3 links that points to the different versions gone into the print.

Add alt-text to images

To make the webpage more accessible. This is really just an umbrella issue as addressing it belongs to all the 3 repos that actually contains the elements of the website.

Some resources about alt-text:

• https://hackmd.io/2uOMXV_fT0ycLyo4uH67HQ
• https://docs.google.com/presentation/d/1PTYVwcu2U6wTY-ozrKEK981CEp79MkBtRJymr2LQgCY/edit#slide=id.gc6f9e470d_0_0

Upload v0.4 updated material

Currently it's 0.2 on the webpage. Update it to 0.3.1 0.4 once the new release is out.

Set up sphinx-gallery for binder deployment of notebooks

Scikit-learn has a rather nice way to deploy examples from the docs with binder.

I think we don't even need the gallery part of the plugin just the deployment, but in either case this needs a bit more experimenting to get it right.

Refactor webpage layout

Would be nice to rethink and redesign the webpage a bit to clean up the layout, etc as currently there isn't an easy way to host multiple versions of the docs, etc.

We can again follow the strategy and design of upstream packages, scikit-learn has changed their landing page since we got their layout, as well as numpy currently is undergoing a webpage redesign.

Auto build and deployment of the website

The website deployment should be triggered by changes to affected parts of the source. The challenge is that the website components are hosted in 3 separate repos while deployed into this one:

• astroML/astroML
• astroML/astroML-figures
• astroML/astroML-notebooks

The build scripts are in the library doc itself, but those can be moved over here if needed. Rendered outputs from the previous build should be used as building everything from zero takes too much time. The two possible avenues I see are:

• have one job, run from cron e.g. daily that runs in this repo, fetches the latest versions of the components and builds and deploys the website if there are any changes.
• cross trigger builds with GH actions. I have yet to find a closeby project that did this, but this discussion should be enough for a start https://github.community/t/triggering-by-other-repository/16163

Add new textbook to the webpage

@ivezic - I think we should update the images and mentions of the textbook on the webpage, as well as maybe some new text.

Do you have a preference for the timing? (e.g. only do after Dec 3, or now)? Any preference for new text?