Skip to content

Commit

Permalink
chore: Update readme and docs
Browse files Browse the repository at this point in the history
Signed-off-by: Frost Ming <me@frostming.com>
  • Loading branch information
frostming committed Aug 4, 2023
1 parent adf4044 commit efb0930
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 6 deletions.
2 changes: 1 addition & 1 deletion README.md
Expand Up @@ -22,7 +22,7 @@ It is mainly inspired by [Lerna](https://lerna.js.org/). In a monorepo, some dep

## Installation

**Monas** requires Python >=3.7.
**Monas** requires Python >=3.8.

It is recommended to install with `pipx`, if `pipx` haven't been installed yet, refer to the [pipx's docs](https://github.com/pipxproject/pipx)

Expand Down
4 changes: 2 additions & 2 deletions docs/conf.py
Expand Up @@ -13,7 +13,7 @@
# import os
# import sys
# sys.path.insert(0, os.path.abspath('.'))

import importlib.metadata

# -- Project information -----------------------------------------------------

Expand All @@ -22,7 +22,7 @@
author = "Frost Ming"

# The full version, including alpha/beta/rc tags
release = "0.1.0"
release = importlib.metadata.version("monas")


# -- General configuration ---------------------------------------------------
Expand Down
6 changes: 3 additions & 3 deletions noxfile.py
Expand Up @@ -5,21 +5,21 @@
os.environ["PDM_IGNORE_SAVED_PYTHON"] = "1"


@nox.session(python=("3.7", "3.8", "3.9", "3.10", "3.11"))
@nox.session(python=("3.8", "3.9", "3.10", "3.11"))
def test(session):
session.run("pdm", "install", "-dGtest", external=True)
session.run("pytest", "tests/")


@nox.session(python="3.9")
@nox.session(python="3.11")
def docs(session):
session.install("-r", "docs/requirements.txt")

# Generate documentation into `build/docs`
session.run("sphinx-build", "-W", "-b", "html", "docs/", "build/docs")


@nox.session(name="docs-live", python="3.9")
@nox.session(name="docs-live", python="3.11")
def docs_live(session):
session.install("-r", "docs/requirements.txt")
session.install("-e", ".")
Expand Down

0 comments on commit efb0930

Please sign in to comment.