Skip to content

Commit

Permalink
chore(docs): remove mkdocs
Browse files Browse the repository at this point in the history
Signed-off-by: JP-Ellis <josh@jpellis.me>
  • Loading branch information
JP-Ellis committed Feb 22, 2024
1 parent 533d32f commit 092a38c
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 23 deletions.
11 changes: 1 addition & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,6 @@ Welcome to this Python coding test. This test is designed to assess your ability
to write clean, well-structured, and maintainable code. You will be tasked with
adding some functionality to this codebase.

## Documentation

MkDocs is used to generate all the documentation, which can be viewed by running

```console
hatch run docs
```

## Development

This project uses [Hatch](https://hatch.pypa.io) for managing the development
Expand All @@ -35,8 +27,7 @@ pypacter/
│ ├── tests/
│ ├── pyproject.toml
│ └── README.md
├── docs/ <== MkDocs documentation
├── notebooks/ <== Jupyter notebooks
├── notebooks/ <== Jupyter notebooks (if any)
├── src/
│ └── pypacter/ <== Core logic
├── tests/
Expand Down
15 changes: 2 additions & 13 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -34,19 +34,10 @@ Issues = "https://github.com/pactflow/pactflow-python-coding-test/issues"
Source = "https://github.com/pactflow/pactflow-python-coding-test"

[project.optional-dependencies]
devel-docs = [
"pathspec",
"mkdocs",
"mkdocs-gen-files",
"mkdocs-literate-nav",
"mkdocs-material",
"mkdocs-section-index",
"mkdocstrings[python]",
]
devel-test = ["pytest", "pytest-cov", "coverage[toml]"]
devel-types = ["mypy==1.8.0", "pydantic~=1.0", "types-pyyaml", "types-pygments"]
devel = [
"pypacter[devel-docs,devel-test,devel-types]",
"pypacter[devel-test,devel-types]",
"pypacter-api[devel]",
"pypacter-cli[devel]",
"ruff==0.2.2",
Expand Down Expand Up @@ -94,11 +85,9 @@ pre-install-commands = [
[tool.hatch.envs.default.scripts]
lint = "ruff check --show-source --show-fixes {args} src tests"
typecheck = "mypy src tests {args}"
format = "ruff format src tests docs {args}"
format = "ruff format src tests {args}"
test = "pytest tests/ {args}"
all = ["format", "lint", "typecheck", "test"]
docs = ["mkdocs serve {args}"]
docs-build = ["mkdocs build {args}"]

[tool.hatch.envs.test]
features = ["devel"]
Expand Down

0 comments on commit 092a38c

Please sign in to comment.