Skip to content
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

publish site docs #115

Merged
merged 40 commits into from
Nov 6, 2024
Merged
Changes from 1 commit
Commits
Show all changes
40 commits
Select commit Hold shift + click to select a range
64518a0
reorg policy docs so GH can reference for community standards
ericbuckley Oct 28, 2024
52b45c5
renaming some existing docs
ericbuckley Oct 28, 2024
2209c58
adding some default docs for mkdocs
ericbuckley Oct 28, 2024
f79be0b
adding mkdocs plugins
ericbuckley Oct 28, 2024
0269e00
setting the default pytest capture mode to "no"
ericbuckley Oct 29, 2024
59f3b53
first pass at installation docs
ericbuckley Oct 29, 2024
ed439fa
create docs/public/
ericbuckley Oct 29, 2024
64f0981
add mkdocs material theme
ericbuckley Oct 29, 2024
db6f987
renaming mkdocs dir
ericbuckley Oct 29, 2024
bae5017
starting config guide
ericbuckley Oct 29, 2024
8679967
Merge branch 'main' into documentation/installation-guide
ericbuckley Oct 29, 2024
2ff15c4
wrapping up changes to configuration docs
ericbuckley Oct 29, 2024
eca3ae6
adding developer guide section
ericbuckley Oct 29, 2024
74762f6
starting Algorithm Config reference guide
ericbuckley Oct 29, 2024
c2b325b
consolidating into developer_guide
ericbuckley Oct 29, 2024
6a89f48
Merge branch 'main' into documentation/installation-guide
ericbuckley Oct 30, 2024
5dcfe25
Merge branch 'main' into documentation/installation-guide
ericbuckley Oct 31, 2024
81c31ab
adding more to the first set of docs
ericbuckley Oct 31, 2024
9e6a284
removing developer_guide from site docs
ericbuckley Oct 31, 2024
7a16be5
reverting change
ericbuckley Oct 31, 2024
ff84c33
removing blocking keys section for now
ericbuckley Oct 31, 2024
b53bdb8
removing capture=no
ericbuckley Oct 31, 2024
48a6f7d
making recordlinker.utils a package
ericbuckley Oct 31, 2024
6f2b722
adding a script to build docs
ericbuckley Oct 31, 2024
7957967
adding release CI steps to build and publish site docs
ericbuckley Oct 31, 2024
1c67765
Merge branch 'main' into documentation/installation-guide
ericbuckley Nov 1, 2024
0741ae9
Merge branch 'documentation/installation-guide' into feature/112-publ…
ericbuckley Nov 1, 2024
6edf098
Merge branch 'main' into feature/112-publish-site-docs
ericbuckley Nov 1, 2024
606fe57
adding simple test to verify openapi_schema.export_json works
ericbuckley Nov 1, 2024
cc1fb3d
updates to release for testing in the PR
ericbuckley Nov 1, 2024
a7c8491
install python deps for building docs
ericbuckley Nov 1, 2024
d1a3434
dont use inital algorithms
ericbuckley Nov 1, 2024
12db09e
test upload docs
ericbuckley Nov 1, 2024
ab7b787
also deploy artifacts
ericbuckley Nov 1, 2024
f53e3ae
adding pages write perm
ericbuckley Nov 1, 2024
7101038
adding version number ot the docs
ericbuckley Nov 1, 2024
a6a9a74
Merge branch 'main' into feature/112-publish-site-docs
ericbuckley Nov 4, 2024
77510fc
removing testing code from release.yml
ericbuckley Nov 4, 2024
df67f77
fixing a typo and description in the references
ericbuckley Nov 4, 2024
5411408
fix typo
ericbuckley Nov 4, 2024
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
adding version number ot the docs
ericbuckley committed Nov 1, 2024
commit 7101038e533f967287bbb6f6c653ea7452210722
1 change: 1 addition & 0 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
@@ -124,6 +124,7 @@ jobs:
python -m pip install --upgrade pip
pip install '.[dev]'
export INITIAL_ALGORITHMS=""
export VERSION=${{ env.NEXT_TAG }}
./scripts/build_docs.sh _site
- name: Upload public documentation
2 changes: 1 addition & 1 deletion docs/mkdocs.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
site_name: "Record Linker Documentation"
site_name: !ENV [SITE_NAME, 'RecordLinker Documentation']
theme:
name: "material"
icon:
4 changes: 3 additions & 1 deletion scripts/build_docs.sh
Original file line number Diff line number Diff line change
@@ -10,7 +10,9 @@ set -e
cd "$(dirname "$0")/.."

OUT=${1:-_site}
VERSION=${VERSION:-$(python -c "from recordlinker._version import __version__; print(f'v{__version__}');")}
SITE_NAME="RecordLinker Documentation (${VERSION})"

mkdocs build --config-file docs/mkdocs.yml -d "../${OUT}"
SITE_NAME=${SITE_NAME} mkdocs build --config-file docs/mkdocs.yml -d "../${OUT}"
python -m recordlinker.utils.openapi_schema > ${OUT}/openapi.json
npx @redocly/cli build-docs -o "${OUT}/api-docs.html" "${OUT}/openapi.json"

Unchanged files with check annotations Beta

Check warning on line 27 in src/recordlinker/linking/link.py

Codecov / codecov/patch

src/recordlinker/linking/link.py#L27

Added line #L27 was not covered by tests
# package into the site-packages
while not (root / "pyproject.toml").exists():
if root.parent == root:
raise FileNotFoundError("Project root with 'pyproject.toml' not found.")

Check warning on line 16 in src/recordlinker/utils/__init__.py

Codecov / codecov/patch

src/recordlinker/utils/__init__.py#L16

Added line #L16 was not covered by tests
root = root.parent
return root
"""
filename = pathlib.Path(project_root(), *filepaths)
with open(filename, "r") as fobj:
return json.load(fobj)

Check warning on line 27 in src/recordlinker/utils/__init__.py

Codecov / codecov/patch

src/recordlinker/utils/__init__.py#L27

Added line #L27 was not covered by tests
if __name__ == "__main__":
export_json(sys.stdout)

Check warning on line 36 in src/recordlinker/utils/openapi_schema.py

Codecov / codecov/patch

src/recordlinker/utils/openapi_schema.py#L36

Added line #L36 was not covered by tests