Skip to content

Commit

Permalink
chore(nox): better order
Browse files Browse the repository at this point in the history
  • Loading branch information
helmut-hoffer-von-ankershoffen committed Jan 4, 2025
1 parent f55f737 commit 984517d
Show file tree
Hide file tree
Showing 6 changed files with 29 additions and 20 deletions.
2 changes: 1 addition & 1 deletion .readthedocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ sphinx:
# Formats of the documentation to be built
formats:
- htmlzip
# - pdf
- pdf


build:
Expand Down
9 changes: 7 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,12 @@
[![ghcr.io - Version](https://ghcr-badge.egpl.dev/helmut-hoffer-von-ankershoffen/starbridge/tags?color=%2344cc11&ignore=0.0%2C0%2Clatest&n=3&label=ghcr.io&trim=)](https://github.com/helmut-hoffer-von-ankershoffen/starbridge/pkgs/container/starbridge)
[![ghcr.io - Sze](https://ghcr-badge.egpl.dev/helmut-hoffer-von-ankershoffen/starbridge/size?color=%2344cc11&tag=latest&label=size&trim=)](https://github.com/helmut-hoffer-von-ankershoffen/starbridge/pkgs/container/starbridge)
-->
> ⚠️ **WARNING**: This project is currently in pre-alpha phase, i.e. partly functional. Feel free to already watch or star the repository to stay updated on its progress.
> [!WARNING]
> This project is currently in pre-alpha phase, i.e. partly functional. Feel free to already watch or star the repository to stay updated on its progress.
> [!TIP]
> 📚 [Online documentation](https://starbridge.readthedocs.io/en/latest/) - 📖 [PDF Manual](https://starbridge.readthedocs.io/_/downloads/en/latest/pdf/)

Integrates Claude Desktop with the web, Atlassian Confluence, and (later on) Google Workspace.

Expand All @@ -31,7 +36,7 @@ Integrates Claude Desktop with the web, Atlassian Confluence, and (later on) Goo

## Qualities

* [Complete reference documenation](https://starbridge.readthedocs.io/en/latest/reference_index.html) on Read the Docs
* [Complete reference documenation](https://starbridge.readthedocs.io/en/latest/reference.html) on Read the Docs
* [High test coverage](https://app.codecov.io/gh/helmut-hoffer-von-ankershoffen/starbridge) including unit and E2E tests (reported on Codecov)
* Matrix tested with [Python 3.11, 3.12 and 3.13](https://github.com/helmut-hoffer-von-ankershoffen/starbridge/blob/main/noxfile.py) to ensure compatibility (powered by [Nox](https://nox.thea.codes/en/stable/))
* 100% compliant with modern linting and formatting standards (powered by [Ruff](https://github.com/astral-sh/ruff))
Expand Down
7 changes: 6 additions & 1 deletion _readme_header.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,4 +21,9 @@
[![ghcr.io - Version](https://ghcr-badge.egpl.dev/helmut-hoffer-von-ankershoffen/starbridge/tags?color=%2344cc11&ignore=0.0%2C0%2Clatest&n=3&label=ghcr.io&trim=)](https://github.com/helmut-hoffer-von-ankershoffen/starbridge/pkgs/container/starbridge)
[![ghcr.io - Sze](https://ghcr-badge.egpl.dev/helmut-hoffer-von-ankershoffen/starbridge/size?color=%2344cc11&tag=latest&label=size&trim=)](https://github.com/helmut-hoffer-von-ankershoffen/starbridge/pkgs/container/starbridge)
-->
> ⚠️ **WARNING**: This project is currently in pre-alpha phase, i.e. partly functional. Feel free to already watch or star the repository to stay updated on its progress.

> [!WARNING]
> This project is currently in pre-alpha phase, i.e. partly functional. Feel free to already watch or star the repository to stay updated on its progress.
> [!TIP]
> 📚 [Online documentation](https://starbridge.readthedocs.io/en/latest/) - 📖 [PDF Manual](https://starbridge.readthedocs.io/_/downloads/en/latest/pdf/)
2 changes: 1 addition & 1 deletion _readme_main.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Integrates Claude Desktop with the web, Atlassian Confluence, and (later on) Goo

## Qualities

* [Complete reference documenation](https://starbridge.readthedocs.io/en/latest/reference_index.html) on Read the Docs
* [Complete reference documenation](https://starbridge.readthedocs.io/en/latest/reference.html) on Read the Docs
* [High test coverage](https://app.codecov.io/gh/helmut-hoffer-von-ankershoffen/starbridge) including unit and E2E tests (reported on Codecov)
* Matrix tested with [Python 3.11, 3.12 and 3.13](https://github.com/helmut-hoffer-von-ankershoffen/starbridge/blob/main/noxfile.py) to ensure compatibility (powered by [Nox](https://nox.thea.codes/en/stable/))
* 100% compliant with modern linting and formatting standards (powered by [Ruff](https://github.com/astral-sh/ruff))
Expand Down
1 change: 0 additions & 1 deletion docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,6 @@
'<a target="_blank" href="https://hub.docker.com/r/helmuthva/starbridge/tags">Docker</a> - '
'<a target="_blank" href="https://sonarcloud.io/summary/new_code?id=helmut-hoffer-von-ankershoffen_starbridge">SonarQube</a> - '
'<a target="_blank" href="https://app.codecov.io/gh/helmut-hoffer-von-ankershoffen/starbridge">Codecov</a>'
'<a target="_blank" href="https://github.com/helmut-hoffer-von-ankershoffen/starbridge/blob/main/LICENSE">License</a>'
),
}

Expand Down
28 changes: 14 additions & 14 deletions noxfile.py
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,20 @@ def lint(session: nox.Session) -> None:
)


@nox.session(python=["3.13"])
def docs(session: nox.Session) -> None:
"""Build documentation and concatenate README."""
_setup_venv(session)
# Concatenate README files
header = Path("_readme_header.md").read_text(encoding="utf-8")
main = Path("_readme_main.md").read_text(encoding="utf-8")
footer = Path("_readme_footer.md").read_text(encoding="utf-8")
readme_content = f"{header}\n\n{main}\n\n{footer}"
Path("README.md").write_text(readme_content, encoding="utf-8")
# Build docs
session.run("make", "-C", "docs", "html", external=True)


@nox.session(python=["3.13"])
def audit(session: nox.Session) -> None:
_setup_venv(session)
Expand Down Expand Up @@ -65,20 +79,6 @@ def audit(session: nox.Session) -> None:
session.run("jq", ".", "sbom.json", external=True)


@nox.session(python=["3.13"])
def docs(session: nox.Session) -> None:
"""Build documentation and concatenate README."""
_setup_venv(session)
# Concatenate README files
header = Path("_readme_header.md").read_text(encoding="utf-8")
main = Path("_readme_main.md").read_text(encoding="utf-8")
footer = Path("_readme_footer.md").read_text(encoding="utf-8")
readme_content = f"{header}\n{main}\n{footer}"
Path("README.md").write_text(readme_content, encoding="utf-8")
# Build docs
session.run("make", "-C", "docs", "html", external=True)


@nox.session(python=["3.11", "3.12", "3.13"])
def test(session: nox.Session) -> None:
_setup_venv(session)
Expand Down

0 comments on commit 984517d

Please sign in to comment.