Open
Conversation
…tion among tutorials (via html redirect); some minor fixes and improvements to .md files for html docs [no ci]
Collaborator
Author
|
In my opinion, it isn't too important to have the automatically generated reST files (docs/source/pisa.stages.xsec.rst and so on, by sphinx-apidoc, which for some reason now produces a changed directive order) in here—or to keep them updated as code structure changes:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The current PISA html docs only contain the auto-generated Python API references/indexes.
In addition to introducing a different theme, this PR includes various of our own resources (selection of important markdown files, jupyter notebooks) in the html docs, as well as a changelog generated from PISA's releases. New sphinx extensions need to be installed to achieve this, as the modified list of develop packages in setup.py reveals.
I've uploaded the docs built from this branch to https://user-web.icecube.wisc.edu/~tehrhardt/pisa_docs so that you can take a look first.