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.

Sign up for GitHub

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

Jump to bottom

Major overhaul of documentation #175

Draft
wants to merge 15 commits into
base: dev_master
Choose a base branch
from
Draft

Major overhaul of documentation #175

wants to merge 15 commits into from

Commits on Jun 2, 2024

  1. Attempt to use new RTD stuff

    @teutoburg
    teutoburg committed Jun 2, 2024
    Configuration menu
    Copy the full SHA
    148852f View commit details
    Browse the repository at this point in the history

  2. Update requirements

    @teutoburg
    teutoburg committed Jun 2, 2024
    Configuration menu
    Copy the full SHA
    b060b63 View commit details
    Browse the repository at this point in the history

  3. Attempt to fix TOC

    @teutoburg
    teutoburg committed Jun 2, 2024
    Configuration menu
    Copy the full SHA
    abbc1ef View commit details
    Browse the repository at this point in the history

  4. Add scopesim-templates to RTD requirements 

    Increase timeout for notebooks

Decrease timeout but cache
    @teutoburg
    teutoburg committed Jun 2, 2024
    Configuration menu
    Copy the full SHA
    f1c2e28 View commit details
    Browse the repository at this point in the history

  5. Exclude expensive notebooks

    @teutoburg
    teutoburg committed Jun 2, 2024
    Configuration menu
    Copy the full SHA
    9ea79ea View commit details
    Browse the repository at this point in the history

  6. Convert demo notebooks and TOC to MyST md format 

    Rearange TOC

Minor refactoring of demo notebooks

Mostly less individual cells.

Change demo notebook titles

This used to be the description in the table in the readme. This way, the more descriptove name will simple show up in the toctree.

Convert RawHeaders to myst md format

Toctree does need the individual files...

Migrate METIS README to md

Formatting some demo notebooks

Migrate to markdown

Formatting

Fix paths

Fix toctree for good

Attempt globbing

Markdownify this as well

Update notebook title for better display in toctree

Attempt to improve this file tree

Filename seems to be case-sensitive

Fix title

Fix markdown
    @teutoburg
    teutoburg committed Jun 2, 2024
    Configuration menu
    Copy the full SHA
    94bef2d View commit details
    Browse the repository at this point in the history

  7. Move index page back to docs/source and migrate to .md 

    Move index back to root...
    @teutoburg
    teutoburg committed Jun 2, 2024
    Configuration menu
    Copy the full SHA
    5eacb3d View commit details
    Browse the repository at this point in the history

  8. Reduce duplication in Installation guide. 

    Outsource quickstart guide

Make intro executable

Improve quickstart guide and use it also for MICADO
    @teutoburg
    teutoburg committed Jun 2, 2024
    Configuration menu
    Copy the full SHA
    213b476 View commit details
    Browse the repository at this point in the history

  9. Disable debug timeout again, remove test files

    @teutoburg
    teutoburg committed Jun 2, 2024
    Configuration menu
    Copy the full SHA
    9520085 View commit details
    Browse the repository at this point in the history

  10. Cleanup demo notebooks, hide wonky outputs

    @teutoburg
    teutoburg committed Jun 2, 2024
    Configuration menu
    Copy the full SHA
    46d8ab6 View commit details
    Browse the repository at this point in the history

  11. Fix for Quantization and SourceFields

    @teutoburg
    teutoburg committed Jun 2, 2024
    Configuration menu
    Copy the full SHA
    caf7deb View commit details
    Browse the repository at this point in the history

  12. Commit executed notebooks

    @teutoburg
    teutoburg committed Jun 2, 2024
    Configuration menu
    Copy the full SHA
    6647b28 View commit details
    Browse the repository at this point in the history

  13. Don't force NB execution

    @teutoburg
    teutoburg committed Jun 2, 2024
    Configuration menu
    Copy the full SHA
    48b3a77 View commit details
    Browse the repository at this point in the history

  14. Fix subheading levels

    @teutoburg
    teutoburg committed Jun 2, 2024
    Configuration menu
    Copy the full SHA
    f55f1fb View commit details
    Browse the repository at this point in the history

  15. Fix nb config

    @teutoburg
    teutoburg committed Jun 2, 2024
    Configuration menu
    Copy the full SHA
    b4dbc2d View commit details
    Browse the repository at this point in the history