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.

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

Add docs #31

Merged
merged 30 commits into from
Aug 27, 2024
Merged

Add docs #31

merged 30 commits into from
Aug 27, 2024

Commits on Aug 17, 2024

  1. Initial docs layout (draft)

    lkubb committed Aug 17, 2024
    Configuration menu
    Copy the full SHA
    49d476a View commit details
    Browse the repository at this point in the history
  2. Allow specifying options for sphinx-autobuild

    For example, overriding the host the docs are served from:
    
    nox -e docs-dev -- --host=1.2.3.4
    lkubb committed Aug 17, 2024
    Configuration menu
    Copy the full SHA
    185b81b View commit details
    Browse the repository at this point in the history

Commits on Aug 18, 2024

  1. Remove parametrization of docs-dev nox task

    It makes invocation cumbersome.
    lkubb committed Aug 18, 2024
    Configuration menu
    Copy the full SHA
    7d9b190 View commit details
    Browse the repository at this point in the history
  2. Simplify test for host arg

    lkubb committed Aug 18, 2024
    Configuration menu
    Copy the full SHA
    3721ab2 View commit details
    Browse the repository at this point in the history
  3. Fix conf.py setup

    lkubb committed Aug 18, 2024
    Configuration menu
    Copy the full SHA
    788428c View commit details
    Browse the repository at this point in the history

Commits on Aug 19, 2024

  1. Add basic testing docs

    lkubb committed Aug 19, 2024
    Configuration menu
    Copy the full SHA
    99ad077 View commit details
    Browse the repository at this point in the history
  2. Add more remarks

    lkubb committed Aug 19, 2024
    Configuration menu
    Copy the full SHA
    80a557a View commit details
    Browse the repository at this point in the history
  3. Configuration menu
    Copy the full SHA
    3e27ab5 View commit details
    Browse the repository at this point in the history

Commits on Aug 20, 2024

  1. Add more drafts

    lkubb committed Aug 20, 2024
    Configuration menu
    Copy the full SHA
    de8f6c4 View commit details
    Browse the repository at this point in the history
  2. Improve docs writing docs

    lkubb committed Aug 20, 2024
    Configuration menu
    Copy the full SHA
    1e2f8d7 View commit details
    Browse the repository at this point in the history
  3. Correct cross-ref hint

    lkubb committed Aug 20, 2024
    Configuration menu
    Copy the full SHA
    013d2c9 View commit details
    Browse the repository at this point in the history
  4. Add updating docs

    lkubb committed Aug 20, 2024
    Configuration menu
    Copy the full SHA
    b6ee308 View commit details
    Browse the repository at this point in the history
  5. Minor fixes/improvements

    lkubb committed Aug 20, 2024
    Configuration menu
    Copy the full SHA
    bce0c96 View commit details
    Browse the repository at this point in the history

Commits on Aug 21, 2024

  1. Configuration menu
    Copy the full SHA
    221747d View commit details
    Browse the repository at this point in the history
  2. Configuration menu
    Copy the full SHA
    7e365fd View commit details
    Browse the repository at this point in the history
  3. Add some historical context

    max-arnold authored and lkubb committed Aug 21, 2024
    Configuration menu
    Copy the full SHA
    e6881a0 View commit details
    Browse the repository at this point in the history
  4. Describe the module extraction process

    max-arnold authored and lkubb committed Aug 21, 2024
    Configuration menu
    Copy the full SHA
    b23891b View commit details
    Browse the repository at this point in the history
  5. Address the review suggestions

    max-arnold authored and lkubb committed Aug 21, 2024
    Configuration menu
    Copy the full SHA
    a6a6d83 View commit details
    Browse the repository at this point in the history
  6. A couple of testing tips

    max-arnold authored and lkubb committed Aug 21, 2024
    Configuration menu
    Copy the full SHA
    cf29c25 View commit details
    Browse the repository at this point in the history

Commits on Aug 26, 2024

  1. Configuration menu
    Copy the full SHA
    77af26b View commit details
    Browse the repository at this point in the history

Commits on Aug 27, 2024

  1. Adjust extraction example

    lkubb committed Aug 27, 2024
    Configuration menu
    Copy the full SHA
    8925080 View commit details
    Browse the repository at this point in the history
  2. Configuration menu
    Copy the full SHA
    a856309 View commit details
    Browse the repository at this point in the history
  3. Correct installation examples

    lkubb committed Aug 27, 2024
    Configuration menu
    Copy the full SHA
    ac36d0f View commit details
    Browse the repository at this point in the history
  4. Configuration menu
    Copy the full SHA
    3f96b7e View commit details
    Browse the repository at this point in the history
  5. Configuration menu
    Copy the full SHA
    b6ec4df View commit details
    Browse the repository at this point in the history
  6. Improve language, add tippy

    lkubb committed Aug 27, 2024
    Configuration menu
    Copy the full SHA
    029bce1 View commit details
    Browse the repository at this point in the history
  7. Address comments

    lkubb committed Aug 27, 2024
    Configuration menu
    Copy the full SHA
    b2a2446 View commit details
    Browse the repository at this point in the history
  8. Fix CSS

    lkubb committed Aug 27, 2024
    Configuration menu
    Copy the full SHA
    5133a59 View commit details
    Browse the repository at this point in the history
  9. Minor adjustments

    lkubb committed Aug 27, 2024
    Configuration menu
    Copy the full SHA
    88cdbe3 View commit details
    Browse the repository at this point in the history
  10. Update README

    lkubb committed Aug 27, 2024
    Configuration menu
    Copy the full SHA
    5fbd6f8 View commit details
    Browse the repository at this point in the history