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

Release v1.1.0 #5

Merged
merged 17 commits into from
Oct 23, 2024
Merged
Show file tree
Hide file tree
Changes from 15 commits
Commits
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
6 changes: 3 additions & 3 deletions .github/workflows/documentation.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ jobs:
# The introduction just shows some useful informations.
intro:
# The type of runner that the job will run on.
runs-on: ubuntu-latest
runs-on: ubuntu-22.04
# Steps represent a sequence of tasks that will be executed as part of the job.
steps:
- run: echo "The job was automatically triggered by a ${{ github.event_name }} event."
Expand All @@ -28,7 +28,7 @@ jobs:
# The build job will build the documentation.
build:
# The type of runner that the job will run on.
runs-on: ubuntu-latest
runs-on: ubuntu-22.04
needs: intro
permissions:
contents: write
Expand All @@ -47,7 +47,7 @@ jobs:
- name: Setup Node
uses: actions/setup-node@v4
with:
node-version: '16'
node-version: '20'
cache: npm

- name: Install dependencies
Expand Down
3 changes: 3 additions & 0 deletions doc/_static/css/width.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
.wy-nav-content {
max-width: none;
}
16 changes: 9 additions & 7 deletions doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,18 +13,19 @@
project = "gitWorkInstructions"
copyright = "2024 - present, NewTec GmbH"
author = "NewTec GmbH"
release = "1.0.0"
release = "1.1.0"
conf_py_path = "/doc/" # with leading and trailing slashes

# -- General configuration ---------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration

extensions = [
"sphinxcontrib.mermaid", # Mermaid diagrams
"myst_parser", # MyST markdown parser
"sphinx_rtd_dark_mode", # Dark mode
"sphinx_copybutton", # Copy button
"sphinx_togglebutton" # Toggle button
"sphinxcontrib.plantuml", # Plantuml diagrams
"myst_parser", # MyST markdown parser
"sphinx_rtd_dark_mode", # Dark mode
"sphinx_copybutton", # Copy button
"sphinx_togglebutton" # Toggle button
]

templates_path = ["_templates"]
Expand All @@ -43,7 +44,8 @@

html_static_path = ["_static"]
html_css_files = [
"css/svg.css"
"css/svg.css",
"css/width.css"
]

# HTML dark theme options
Expand All @@ -58,7 +60,7 @@
mermaid_cmd_shell = "true"

# MyST configuration
myst_enable_extensions = ["colon_fence"]
myst_enable_extensions = ["colon_fence", 'attrs_block']
myst_heading_anchors = 2

# Toggle button configuration
Expand Down
6 changes: 6 additions & 0 deletions doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -69,3 +69,9 @@ This documentation is intended to introduce the overall branching strategy to be
merge bugfix/Button
checkout main
merge release/v3.0.x tag: "v3.0.0"

.. toctree::
:caption: Submodule Config Management:
:maxdepth: 2

versioning/submod_versioning.md
gabryelreyes marked this conversation as resolved.
Show resolved Hide resolved
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/versioning/images/gitmodule_entry.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/versioning/images/gitmodules_diffs.png
gabryelreyes marked this conversation as resolved.
Show resolved Hide resolved
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/versioning/images/submodule_versioning.png
gabryelreyes marked this conversation as resolved.
Show resolved Hide resolved
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading