Add Docs Page

[JP-Ellis]

Have you read the Contributing Guidelines on issues?

• I have read the Contributing Guidelines on issues.

Description

This issue is, firstly, a discussion. There are a few aspects which need to be discussed. The main points are:

• Which technology to use (see in motivation for some contenders)
• How to host it:
  • Do we use GitHub pages in this repository?
  • How do we unify the Pact Python docs with the broader Pact docs over at docs.pact.io.

Has this been requested on Canny?

No response

Motivation

The Pact Python should really have a documentation website for its internals. There are a few common ways of doing this in the Python ecosystem:

• MkDocs + MkDocs Material
  • Example: Griffe
  • Example: MkDocs Material
• Sphinx + Read the Docs
  • Example: Requests
  • Example: Flask
• Docusaurus (used by docs.pact.io)
  • Example: ? (I do not know of Python packages that use Docusaurus)

Have you tried building it?

A sample MkDocs configuration is available at #414

Self-service

• I'd be willing to contribute this feature to Pact Python myself.

[github-actions]

🤖 Great news! We've labeled this issue as smartbear-supported and created a tracking ticket in PactFlow's Jira (PACT-1404). We'll keep work public and post updates here. Meanwhile, feel free to check out our docs. Thanks for your patience!

[JP-Ellis]

Closed by #414