Skip to content

Review need for docs/_static directory in .readthedocs.yaml #20

@lawrenceabird

Description

@lawrenceabird

Review RTD pre-build steps

To view tutorials on RTD

Within the access-crysophere-data-pool repo, tutorials exist as a top-level directory, outside of the docs/ directory. In order to make them available to be rendered inside the RTD framework, we need to copy them to the docs/ directory. We do that here:

      - cp -r tutorials docs/source/tutorials

Downloading the tutorials

When viewing tutorial files, a "Download Notebook" button is included at the bottom of the notebook. This is plain HTML to allow readers to download the notebook to their local machine.

When originally rendering the documentation with Github Pages using sphinx, I needed to get these files to docs/_static to "remain available" for downloading after the site was built. I included this functionality in the RTD build as I suspected it was still the case (here):

      - mkdir docs/source/_static
      - cp -r tutorials docs/source/_static/tutorials

This process works and Notebooks can be downloaded successfully. @atteggiani thinks this step may not be necessary and perhaps tutorials only need be copied to one location.

TODO

  • Review the need to copy these tutorials twice
  • Update the associated download/relative path in the notebook here: "<a href=\"../_static/tutorials/1_CCD_Overview.ipynb\" download=\"1_CCD_Overview.ipynb\"\n",

Thoughts

Maybe the rendering can be done using the versions copied to docs/_static? Then remove the copy to docs/tutorials.

Metadata

Metadata

Labels

datapoolDefault label for ACCESS Cryosphere Data Pool Issues

Type

No type
No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions