-
Notifications
You must be signed in to change notification settings - Fork 137
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
docs: setup mkdocs #414
Commits on Apr 5, 2024
-
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>
Configuration menu - View commit details
-
Copy full SHA for 15a7f5c - Browse repository at this point
Copy the full SHA 15a7f5cView commit details -
Configuration menu - View commit details
-
Copy full SHA for ce11e1d - Browse repository at this point
Copy the full SHA ce11e1dView commit details -
chore(docs): update emoji indices/generators
The emoji extensions have been incorporated directly into mkdocs-material. Signed-off-by: JP-Ellis <josh@jpellis.me>
Configuration menu - View commit details
-
Copy full SHA for 8a8f00a - Browse repository at this point
Copy the full SHA 8a8f00aView commit details -
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>
Configuration menu - View commit details
-
Copy full SHA for 52faa49 - Browse repository at this point
Copy the full SHA 52faa49View commit details -
docs: ignore private python modules
Signed-off-by: JP-Ellis <josh@jpellis.me>
Configuration menu - View commit details
-
Copy full SHA for 1b21de6 - Browse repository at this point
Copy the full SHA 1b21de6View commit details -
Configuration menu - View commit details
-
Copy full SHA for b97cf23 - Browse repository at this point
Copy the full SHA b97cf23View commit details -
chore(docs): enforce fenced code blocks
Signed-off-by: JP-Ellis <josh@jpellis.me>
Configuration menu - View commit details
-
Copy full SHA for da18e10 - Browse repository at this point
Copy the full SHA da18e10View commit details -
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>
Configuration menu - View commit details
-
Copy full SHA for 7d152da - Browse repository at this point
Copy the full SHA 7d152daView commit details -
chore(docs): minor fixes in examples/
Signed-off-by: JP-Ellis <josh@jpellis.me>
Configuration menu - View commit details
-
Copy full SHA for deb9597 - Browse repository at this point
Copy the full SHA deb9597View commit details -
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>
Configuration menu - View commit details
-
Copy full SHA for 0575391 - Browse repository at this point
Copy the full SHA 0575391View commit details -
chore: remove redundant __all__
Signed-off-by: JP-Ellis <josh@jpellis.me>
Configuration menu - View commit details
-
Copy full SHA for c1f3259 - Browse repository at this point
Copy the full SHA c1f3259View commit details -
refactor: remove relative imports
Signed-off-by: JP-Ellis <josh@jpellis.me>
Configuration menu - View commit details
-
Copy full SHA for 4da86d3 - Browse repository at this point
Copy the full SHA 4da86d3View commit details -
chore(docs): update examples/readme.md
Fix typos Authored-By: JosephBJoyce Cherry-Picked-By: JP-Ellis <josh@jpellis.me>
Configuration menu - View commit details
-
Copy full SHA for 0cf605e - Browse repository at this point
Copy the full SHA 0cf605eView commit details
Commits on Apr 7, 2024
-
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>
Configuration menu - View commit details
-
Copy full SHA for 02ec225 - Browse repository at this point
Copy the full SHA 02ec225View commit details
Commits on Apr 10, 2024
-
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>
Configuration menu - View commit details
-
Copy full SHA for c352b21 - Browse repository at this point
Copy the full SHA c352b21View commit details -
chore(docs): only publish from master
Signed-off-by: JP-Ellis <josh@jpellis.me>
Configuration menu - View commit details
-
Copy full SHA for 0b1f928 - Browse repository at this point
Copy the full SHA 0b1f928View commit details