Skip to content

Commit

Permalink
Rewrite the mkdocs template so the links point to the correct version… (
Browse files Browse the repository at this point in the history
#1943)

… (#1942)

#### Reference Issues/PRs
<!--Example: Fixes #1234. See also #3456.-->

#### What does this implement or fix?

#### Any other comments?

#### Checklist

<details>
  <summary>
   Checklist for code changes...
  </summary>
 
- [ ] Have you updated the relevant docstrings, documentation and
copyright notice?
- [ ] Is this contribution tested against [all ArcticDB's
features](../docs/mkdocs/docs/technical/contributing.md)?
- [ ] Do all exceptions introduced raise appropriate [error
messages](https://docs.arcticdb.io/error_messages/)?
 - [ ] Are API changes highlighted in the PR description?
- [ ] Is the PR labelled as enhancement or bug so it appears in
autogenerated release notes?
</details>

<!--
Thanks for contributing a Pull Request to ArcticDB! Please ensure you
have taken a look at:
- ArcticDB's Code of Conduct:
https://github.com/man-group/ArcticDB/blob/master/CODE_OF_CONDUCT.md
- ArcticDB's Contribution Licensing:
https://github.com/man-group/ArcticDB/blob/master/docs/mkdocs/docs/technical/contributing.md#contribution-licensing
-->

#### Reference Issues/PRs
<!--Example: Fixes #1234. See also #3456.-->

#### What does this implement or fix?

#### Any other comments?

#### Checklist

<details>
  <summary>
   Checklist for code changes...
  </summary>
 
- [ ] Have you updated the relevant docstrings, documentation and
copyright notice?
- [ ] Is this contribution tested against [all ArcticDB's
features](../docs/mkdocs/docs/technical/contributing.md)?
- [ ] Do all exceptions introduced raise appropriate [error
messages](https://docs.arcticdb.io/error_messages/)?
 - [ ] Are API changes highlighted in the PR description?
- [ ] Is the PR labelled as enhancement or bug so it appears in
autogenerated release notes?
</details>

<!--
Thanks for contributing a Pull Request to ArcticDB! Please ensure you
have taken a look at:
- ArcticDB's Code of Conduct:
https://github.com/man-group/ArcticDB/blob/master/CODE_OF_CONDUCT.md
- ArcticDB's Contribution Licensing:
https://github.com/man-group/ArcticDB/blob/master/docs/mkdocs/docs/technical/contributing.md#contribution-licensing
-->
  • Loading branch information
G-D-Petrov authored Oct 24, 2024
1 parent 85c5ed0 commit baacc98
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 2 deletions.
7 changes: 7 additions & 0 deletions .github/workflows/docs_build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,13 @@ jobs:
set -x
pip3 install mkdocs-material mkdocs-jupyter mkdocstrings[python] black pybind11-stubgen mike ${{inputs.version && format('arcticdb=={0}',inputs.version) || 'arcticdb-*.whl'}}
- name: Rewrite the template so the links point to the correct version
if: ${{!inputs.version}}
run: |
set -x
cd docs/mkdocs
sed -i "s/VERSION_PLACEHOLDER/v${{inputs.version}}/g" overrides/main.html
- name: Stubfile generation for arcticdb_ext
run: |
set -x
Expand Down
4 changes: 2 additions & 2 deletions docs/mkdocs/overrides/main.html
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
{% if page.nb_url %}
<p>
<h1>{{page.file.name}}</h1>
<a href="https://github.com/man-group/ArcticDB/blob/master/docs/mkdocs/docs/{{page.file.src_uri}}">
<a href="https://github.com/man-group/ArcticDB/blob/VERSION_PLACEHOLDER/docs/mkdocs/docs/{{page.file.src_uri}}">
<span class="twemoji">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
<title>github</title>
Expand All @@ -23,7 +23,7 @@ <h1>{{page.file.name}}</h1>
</a>
|
<a
href="https://colab.research.google.com/github/man-group/ArcticDB/blob/master/docs/mkdocs/docs/{{page.file.src_uri}}">
href="https://colab.research.google.com/github/man-group/ArcticDB/blob/VERSION_PLACEHOLDER/docs/mkdocs/docs/{{page.file.src_uri}}">
<span class="twemoji">
<svg viewBox="0 0 24 24" preserveAspectRatio="xMidYMid meet" focusable="false" width="977" height="602"
style="height: 28px; width: 28px;">
Expand Down

0 comments on commit baacc98

Please sign in to comment.