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

docs: setup mkdocs #414

Merged
merged 16 commits into from
Apr 10, 2024
Merged

docs: setup mkdocs #414

merged 16 commits into from
Apr 10, 2024

Commits on Apr 5, 2024

  1. docs: setup mkdocs

    MkDocs is a popular tool in the Python ecosystem to generate
    documentation. It has support for parsing Python docstrings in order to
    generate API documentation quite easily.
    
    Signed-off-by: JP-Ellis <josh@jpellis.me>
    JP-Ellis committed Apr 5, 2024
    Configuration menu
    Copy the full SHA
    15a7f5c View commit details
    Browse the repository at this point in the history
  2. docs: update README

    Signed-off-by: JP-Ellis <josh@jpellis.me>
    JP-Ellis committed Apr 5, 2024
    Configuration menu
    Copy the full SHA
    ce11e1d View commit details
    Browse the repository at this point in the history
  3. chore(docs): update emoji indices/generators

    The emoji extensions have been incorporated directly into
    mkdocs-material.
    
    Signed-off-by: JP-Ellis <josh@jpellis.me>
    JP-Ellis committed Apr 5, 2024
    Configuration menu
    Copy the full SHA
    8a8f00a View commit details
    Browse the repository at this point in the history
  4. docs: rework mkdocs-gen-files scripts

    The scripts are significantly improved to make them easier to use and
    maintain.
    
    Signed-off-by: JP-Ellis <josh@jpellis.me>
    JP-Ellis committed Apr 5, 2024
    Configuration menu
    Copy the full SHA
    52faa49 View commit details
    Browse the repository at this point in the history
  5. docs: ignore private python modules

    Signed-off-by: JP-Ellis <josh@jpellis.me>
    JP-Ellis committed Apr 5, 2024
    Configuration menu
    Copy the full SHA
    1b21de6 View commit details
    Browse the repository at this point in the history
  6. chore(docs): fix typos

    Signed-off-by: JP-Ellis <josh@jpellis.me>
    JP-Ellis committed Apr 5, 2024
    Configuration menu
    Copy the full SHA
    b97cf23 View commit details
    Browse the repository at this point in the history
  7. chore(docs): enforce fenced code blocks

    Signed-off-by: JP-Ellis <josh@jpellis.me>
    JP-Ellis committed Apr 5, 2024
    Configuration menu
    Copy the full SHA
    da18e10 View commit details
    Browse the repository at this point in the history
  8. docs: overhaul readme

    The main README has been completely overhauled:
    
    - It is now more closely aligned with Pact JS and Pact Go
    - It is much shorter, with usage documentation having been moved into
      `/docs`
    - Reference to Pact Python `v3` has been added.
    
    Signed-off-by: JP-Ellis <josh@jpellis.me>
    JP-Ellis committed Apr 5, 2024
    Configuration menu
    Copy the full SHA
    7d152da View commit details
    Browse the repository at this point in the history
  9. chore(docs): minor fixes in examples/

    Signed-off-by: JP-Ellis <josh@jpellis.me>
    JP-Ellis committed Apr 5, 2024
    Configuration menu
    Copy the full SHA
    deb9597 View commit details
    Browse the repository at this point in the history
  10. docs: update v3 docs

    This is a major write up of docs for V3. Including the following
    changes:
    
    - Adding a timeline to make it clearly visible
    - Added usage documentation within the modules
    - Consolidated all `Interaction` classes into one module, and hiding the
      sub-modules from the docs.
    
    Signed-off-by: JP-Ellis <josh@jpellis.me>
    JP-Ellis committed Apr 5, 2024
    Configuration menu
    Copy the full SHA
    0575391 View commit details
    Browse the repository at this point in the history
  11. chore: remove redundant __all__

    Signed-off-by: JP-Ellis <josh@jpellis.me>
    JP-Ellis committed Apr 5, 2024
    Configuration menu
    Copy the full SHA
    c1f3259 View commit details
    Browse the repository at this point in the history
  12. refactor: remove relative imports

    Signed-off-by: JP-Ellis <josh@jpellis.me>
    JP-Ellis committed Apr 5, 2024
    Configuration menu
    Copy the full SHA
    4da86d3 View commit details
    Browse the repository at this point in the history
  13. chore(docs): update examples/readme.md

    Fix typos
    
    Authored-By: JosephBJoyce
    Cherry-Picked-By: JP-Ellis <josh@jpellis.me>
    JosephBJoyce authored and JP-Ellis committed Apr 5, 2024
    Configuration menu
    Copy the full SHA
    0cf605e View commit details
    Browse the repository at this point in the history

Commits on Apr 7, 2024

  1. docs: fix links to docs/

    Due to the processing that is done on files outside of `docs/`, links to
    file _inside_ the `docs/` directory do not work.
    
    This adds a hook to MkDocs which rewrites these links.
    
    Signed-off-by: JP-Ellis <josh@jpellis.me>
    JP-Ellis committed Apr 7, 2024
    Configuration menu
    Copy the full SHA
    02ec225 View commit details
    Browse the repository at this point in the history

Commits on Apr 10, 2024

  1. chore(ci): update environment variables

    Specifically, adding `FORCE_COLOR` to ensure we have coloured output (it
    is prettier afterall), and making sure `HATCH_VERBOSE` is always enabled
    in case there's an error.
    
    Signed-off-by: JP-Ellis <josh@jpellis.me>
    JP-Ellis committed Apr 10, 2024
    Configuration menu
    Copy the full SHA
    c352b21 View commit details
    Browse the repository at this point in the history
  2. chore(docs): only publish from master

    Signed-off-by: JP-Ellis <josh@jpellis.me>
    JP-Ellis committed Apr 10, 2024
    Configuration menu
    Copy the full SHA
    0b1f928 View commit details
    Browse the repository at this point in the history