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

[WIP] Refactor and update to Documenter v1.0 #13

Open
wants to merge 9 commits into
base: master
Choose a base branch
from
Open

[WIP] Refactor and update to Documenter v1.0 #13

wants to merge 9 commits into from

Commits on Mar 27, 2024

  1. Move mkdocs assets to a mkdocs folder

    @asinghvi17
    asinghvi17 committed Mar 27, 2024
    Configuration menu
    Copy the full SHA
    50beb80 View commit details
    Browse the repository at this point in the history

  2. Update Project.toml, README.md, and docs

    @asinghvi17
    asinghvi17 committed Mar 27, 2024
    Configuration menu
    Copy the full SHA
    cda1e4a View commit details
    Browse the repository at this point in the history

  3. Big reimplementation 

    - Writing methods are updated to use Documenter 1.0 and dispatch on markdown flavors defined by settings
- MIME rendering is changed to method based dispatch on `render_mime` for more control and flexibility
- New Markdown renderer types defined
- Skeletons for inventory.jl

Co-authored-by: Avik Pal <avikpal@mit.edu>
Co-authored-by: Roger Luo <rogerluo.rl18@gmail.com>
    @asinghvi17 @avik-pal @Roger-luo
    3 people committed Mar 27, 2024
    Configuration menu
    Copy the full SHA
    f046ae8 View commit details
    Browse the repository at this point in the history

  4. Change docs/make.jl to not deploy and use correct syntax

    @asinghvi17
    asinghvi17 committed Mar 27, 2024
    Configuration menu
    Copy the full SHA
    b5466be View commit details
    Browse the repository at this point in the history

  5. Fix tests

    @asinghvi17
    asinghvi17 committed Mar 27, 2024
    Configuration menu
    Copy the full SHA
    3c381db View commit details
    Browse the repository at this point in the history

  6. Fix test example doc page files

    @asinghvi17
    asinghvi17 committed Mar 27, 2024
    Configuration menu
    Copy the full SHA
    23c2aec View commit details
    Browse the repository at this point in the history

  7. Implement inventory file writing from Documenter 

    This is sort of type piracy...it creates a struct, which parallels the fields of `Documenter.HTMLContext` that we care about.

No behaviour in Documenter changes but the function is vulnerable to changes in Documenter internals.
    @asinghvi17
    asinghvi17 committed Mar 27, 2024
    Configuration menu
    Copy the full SHA
    f1b4adc View commit details
    Browse the repository at this point in the history

  8. Correct docs/make.jl

    @asinghvi17
    asinghvi17 committed Mar 27, 2024
    Configuration menu
    Copy the full SHA
    78baa94 View commit details
    Browse the repository at this point in the history

Commits on Mar 29, 2024

  1. Add a note about what exactly the MarkdownContext stuff is doing.

    @asinghvi17
    asinghvi17 committed Mar 29, 2024
    Configuration menu
    Copy the full SHA
    2d4391b View commit details
    Browse the repository at this point in the history