Skip to content

Commit d53eeed

Browse files
averseyaversey
authored
[FSTORE-1921] Improve documentation building process (#738)
* A fix for multirepo plugin * Move docs * Attempt to use mkdocstrings * A fix of path in alerts * Should work now even with the aliases * Fix it back * Fix docstrings in alerts_api.py * Fixes for AlertsApi * Fix Project.get_alerts_api docstring and type hint * More fixes for the AlertsApi docs * Adapt projects.md * Fix AlertsApi docs * Add titles * Attempt to use nv import * Fix * Fix of paths * Fix javadoc link * Fix docstrings of alerts and project * Show full path for Project * Update action * Add multirepo dependency * Prepare for multirepo builds * Add markdownlint * Fix typing error * Add markdownlint config and fixes * More fixes * Update markdownlint action * A bit of markdown fixes * Fix login API * Fix UDF * Fix the trigger-rebuild payload * Fix UDF import * Fix login docstrings * An attempt to fix login docstring * A bit more fixes of login docstrings * A bit more of fixes of the docs * Finish the platform API docs * Transform API reference into the new format * Add missing pages * Fix mistype * Show inherited members of FeatureGroup * Start converting docstrings to Google style * An update of CONTRIBUTING,md * Update docstrings up to feature_group * Fix lists in feature_group * Convert up to storage_connector With a TODO in feature_view. * A bit more work in storage_connector * Fix Attributes * A bit more conversions * Fixes * Fix links * Flatten the docs structure for easier linking * Update deps * Fix deps * Fix mkdocs.yaml * Add inventories * Remove a todo * Fix links in links * Convert example-headers * Fix links * Add more docs * Fix paths * Fix labels * Copy CONTRIBUTING.md * Update CONTRIBUTING.md * Ruff * Ruff * Ruff * Ruff * Update CONTRIBUTING.md * Ruff * Ruff * Ruff * Ruff * Ruff * Ruff * Ruff * Ruff TC * Ruff future annotations * Ruff * MDlint * Update ruff * Update ruff in actions * More fixes * Fix * Fix imports * Fix * Fix typo * Handle CONTRIBUTING doc page via a symlink * Turn symlink the other way around * Update CONTRIBUTING.md * Update * The last fix of headers * Fix links * Fix links * Fix more links * More link fixes * Fix aliases in hsml * Fix some exception docstrings * Add OpensearchRequestOption docs * More fixes * A fix * Sync mkdocs.yml * Fix code blocks * Final change * Remove redundant copying * Fix mkdocs.yml * Fix * Pin versions * Triggger deployment of dev docs * Update contributing guidelines on patch notes * Mention the development version
1 parent fd0da54 commit d53eeed

File tree

363 files changed

+13629
-17128
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

363 files changed

+13629
-17128
lines changed

‎.github/pull_request_template.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
This PR adds/fixes/changes...
2-
- please summarize your changes to the code
2+
3+
- please summarize your changes to the code
34
- and make sure to include all changes to user-facing APIs
45

56
JIRA Issue: -
@@ -14,10 +15,9 @@ Related PRs: -
1415
- [ ] Integration Tests
1516
- [ ] Manual Tests on VM
1617

17-
1818
**Checklist For The Assigned Reviewer:**
1919

20-
```
20+
```markdown
2121
- [ ] Checked if merge conflicts with master exist
2222
- [ ] Checked if stylechecks for Java and Python pass
2323
- [ ] Checked if all docstrings were added and/or updated appropriately

‎.github/workflows/mkdocs-release.yml‎

Lines changed: 8 additions & 56 deletions
Original file line numberDiff line numberDiff line change
@@ -2,66 +2,18 @@ name: mkdocs-release
22

33
on:
44
push:
5-
branches: [branch-*]
5+
branches:
6+
- branch-*
7+
- main
68

79
jobs:
810
publish-release:
911
runs-on: ubuntu-latest
1012

1113
steps:
12-
- uses: actions/checkout@v4
13-
with:
14-
fetch-depth: 0
15-
16-
- name: set major/minor/bugfix release version
17-
working-directory: ./java
18-
run: echo "RELEASE_VERSION=$(mvn org.apache.maven.plugins:maven-help-plugin:2.1.1:evaluate -Dexpression=project.version | grep -Ev 'Download|INFO|WARNING')" >> $GITHUB_ENV
19-
20-
- name: set major/minor release version
21-
run: echo "MAJOR_VERSION=$(echo $RELEASE_VERSION | sed 's/^\([0-9]*\.[0-9]*\).*$/\1/')" >> $GITHUB_ENV
22-
23-
- uses: actions/setup-python@v5
24-
with:
25-
python-version: "3.10"
26-
27-
- name: Install uv
28-
uses: astral-sh/setup-uv@v7
29-
with:
30-
activate-environment: true
31-
working-directory: python
32-
33-
- name: install deps
34-
working-directory: python
35-
run: cp ../README.md . && uv sync --extra dev --group docs
36-
37-
- name: generate autodoc
38-
run: python python/auto_doc.py
39-
40-
- name: Cache local Maven repository
41-
uses: actions/cache@v4
42-
with:
43-
path: ~/.m2/repository
44-
key: ${{ runner.os }}-maven-${{ hashFiles('java/pom.xml') }}
45-
restore-keys: |
46-
${{ runner.os }}-maven-
47-
48-
- name: Set up JDK 8
49-
uses: actions/setup-java@v5
50-
with:
51-
java-version: "8"
52-
distribution: "adopt"
53-
54-
- name: Build java doc documentation
55-
working-directory: ./java
56-
run:
57-
mvn clean install javadoc:javadoc javadoc:aggregate -DskipTests && cp -r target/site/apidocs ../docs/javadoc
58-
59-
- name: setup git
60-
run: |
61-
git config --global user.name Mike
62-
git config --global user.email [email protected]
63-
64-
- name: mike deploy docs
14+
- name: Trigger documentation rebuild
6515
run: |
66-
mike deploy ${{ env.RELEASE_VERSION }} ${{ env.MAJOR_VERSION }} -u --push
67-
mike alias ${{ env.RELEASE_VERSION }} latest -u --push
16+
curl -XPOST -H "Authorization: Bearer ${{ secrets.ACCESS_TOKEN }}" \
17+
-H "Content-Type: application/json" \
18+
-d "{\"event_type\": \"trigger-rebuild\", \"client_payload\": {\"branch\": \"${GITHUB_REF#refs/heads/}\"}}" \
19+
https://api.github.com/repos/logicalclocks/logicalclocks.github.io/dispatches

.github/workflows/mkdocs-main.yml renamed to .github/workflows/mkdocs-test.yml

Lines changed: 25 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,24 @@
1-
name: mkdocs-main
1+
name: mkdocs-test
22

33
on: pull_request
44

55
jobs:
6-
publish-main:
6+
mkdocs:
77
runs-on: ubuntu-latest
88

99
steps:
1010
- uses: actions/checkout@v4
1111
with:
1212
fetch-depth: 0
1313

14-
- name: set dev version
15-
working-directory: ./java
16-
run: echo "DEV_VERSION=$(mvn org.apache.maven.plugins:maven-help-plugin:2.1.1:evaluate -Dexpression=project.version | grep -Ev 'Download|INFO|WARNING')" >> $GITHUB_ENV
17-
18-
- uses: actions/setup-python@v5
14+
- name: Markdownlint
15+
uses: DavidAnson/markdownlint-cli2-action@v21
1916
with:
20-
python-version: "3.10"
17+
globs: '**/*.md'
2118

22-
- name: Install uv
23-
uses: astral-sh/setup-uv@v7
24-
with:
25-
activate-environment: true
26-
working-directory: python
27-
28-
- name: install deps
29-
working-directory: python
30-
run: cp ../README.md . && uv sync --extra dev --group docs
31-
32-
- name: generate autodoc
33-
run: python python/auto_doc.py
19+
- name: set dev version
20+
working-directory: java
21+
run: echo "DEV_VERSION=$(mvn org.apache.maven.plugins:maven-help-plugin:2.1.1:evaluate -Dexpression=project.version | grep -Ev 'Download|INFO|WARNING')" >> $GITHUB_ENV
3422

3523
- name: Cache local Maven repository
3624
uses: actions/cache@v4
@@ -46,14 +34,27 @@ jobs:
4634
java-version: "8"
4735
distribution: "adopt"
4836

49-
- name: Build java doc documentation
50-
working-directory: ./java
37+
- name: Build javadoc documentation
38+
working-directory: java
5139
run: mvn clean install javadoc:javadoc javadoc:aggregate -DskipTests && cp -r target/site/apidocs ../docs/javadoc
5240

53-
- name: setup git
41+
- uses: actions/setup-python@v5
42+
with:
43+
python-version: "3.10"
44+
45+
- name: Install uv
46+
uses: astral-sh/setup-uv@v7
47+
with:
48+
activate-environment: true
49+
working-directory: python
50+
51+
- name: Install dependencies
52+
run: uv sync --extra dev --group docs --project python
53+
54+
- name: Setup git for mike
5455
run: |
5556
git config --global user.name Mike
5657
git config --global user.email [email protected]
5758
58-
- name: mike deploy docs
59+
- name: Generate the docs with mike
5960
run: mike deploy ${{ env.DEV_VERSION }} dev -u

‎.github/workflows/python.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ jobs:
3131
- '!python/tests/test_helpers/transformation_test_helper.py'
3232
3333
- name: install deps
34-
run: pip install ruff==0.4.2
34+
run: pip install ruff==0.14.8
3535

3636
- name: ruff on python files
3737
if: steps.get-changed-files.outputs.src_any_changed == 'true'

‎.gitignore‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -135,7 +135,6 @@ delombok/
135135
# mkdocs intemediate files
136136
docs/generated
137137

138-
docs/CONTRIBUTING.md
139138
docs/index.md
140139

141140
# Test artifacts

‎.markdownlint.yaml‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
MD041: false
2+
MD013: false
3+
MD033: false
4+
MD045: false
5+
MD046: false
6+
MD052: false
7+
MD004:
8+
style: dash

0 commit comments

Comments
 (0)