Skip to content

Commit

Permalink
Deployed 59765dc to main with MkDocs 1.6.1 and mike 2.1.3
Browse files Browse the repository at this point in the history
  • Loading branch information
@bakdata-bot
bakdata-bot committed Jan 15, 2025
1 parent 48f438f commit cef70d0
Show file tree
Hide file tree
Showing 3 changed files with 3 additions and 96 deletions.
2 changes: 1 addition & 1 deletion main/developer/auto-generation/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1989,7 +1989,7 @@


<h1 id="auto-generation">Auto generation<a class="headerlink" href="#auto-generation" title="Permanent link">&para;</a></h1>
<p>Auto generation happens mostly with <a href="https://pre-commit.com/"><code>pre-commit</code></a> hooks. You can find the pre-commit configuration <a href="https://github.com/bakdata/kpops/blob/main/.pre-commit-config.yaml">here</a>. These pre-commit hooks call different <a href="https://github.com/bakdata/kpops/tree/main/hooks">Python scripts</a> to auto generate code for the documentation.</p>
<p>Auto generation happens mostly with Git hooks. You can find the <a href="https://evilmartians.github.io/lefthook/"><code>lefthook</code></a> configuration <a href="https://github.com/bakdata/kpops/blob/main/lefthook.yaml">here</a>. These pre-commit hooks call different <a href="https://github.com/bakdata/kpops/tree/main/hooks">Python scripts</a> to auto generate code for the documentation.</p>
<h2 id="generation-scripts-and-their-respective-files">Generation scripts and their respective files<a class="headerlink" href="#generation-scripts-and-their-respective-files" title="Permanent link">&para;</a></h2>
<h3 id="documentation"><a href="https://github.com/bakdata/kpops/tree/main/hooks/gen_docs">Documentation</a><a class="headerlink" href="#documentation" title="Permanent link">&para;</a></h3>
<h4 id="variables"><a href="https://github.com/bakdata/kpops/tree/main/docs/docs/resources/variables">Variables</a><a class="headerlink" href="#variables" title="Permanent link">&para;</a></h4>
Expand Down
95 changes: 1 addition & 94 deletions main/developer/contributing/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1706,48 +1706,6 @@
</span>
</a>

<nav class="md-nav" aria-label="Style">
<ul class="md-nav__list">

<li class="md-nav__item">
<a href="#python" class="md-nav__link">
<span class="md-ellipsis">
Python
</span>
</a>

</li>

<li class="md-nav__item">
<a href="#markdown" class="md-nav__link">
<span class="md-ellipsis">
Markdown
</span>
</a>

</li>

<li class="md-nav__item">
<a href="#css" class="md-nav__link">
<span class="md-ellipsis">
CSS
</span>
</a>

</li>

<li class="md-nav__item">
<a href="#toml" class="md-nav__link">
<span class="md-ellipsis">
TOML
</span>
</a>

</li>

</ul>
</nav>

</li>

</ul>
Expand Down Expand Up @@ -1884,48 +1842,6 @@
</span>
</a>

<nav class="md-nav" aria-label="Style">
<ul class="md-nav__list">

<li class="md-nav__item">
<a href="#python" class="md-nav__link">
<span class="md-ellipsis">
Python
</span>
</a>

</li>

<li class="md-nav__item">
<a href="#markdown" class="md-nav__link">
<span class="md-ellipsis">
Markdown
</span>
</a>

</li>

<li class="md-nav__item">
<a href="#css" class="md-nav__link">
<span class="md-ellipsis">
CSS
</span>
</a>

</li>

<li class="md-nav__item">
<a href="#toml" class="md-nav__link">
<span class="md-ellipsis">
TOML
</span>
</a>

</li>

</ul>
</nav>

</li>

</ul>
Expand Down Expand Up @@ -1957,16 +1873,7 @@ <h3 id="git">git<a class="headerlink" href="#git" title="Permanent link">&para;<
</span></code></pre></div></td></tr></table></div>
<p>This will fetch the resources under the <code>examples</code> folder.</p>
<h2 id="style">Style<a class="headerlink" href="#style" title="Permanent link">&para;</a></h2>
<p>We advise that you stick to our <code>pre-commit</code> hooks for code linting, formatting, and auto-generation of documentation. After you install them using <code>pre-commit install</code> they're triggered automatically during <code>git commit</code>. Additionally, you can manually invoke them with <code>pre-commit run -a</code>. In order for <code>dprint</code> to work, you have to manually <a href="#markdown">install</a> it locally. It will work in the CI, so it is also possible to manually carry out formatting changes flagged by <code>dprint</code> in the CI and skip installing it locally.</p>
<h3 id="python">Python<a class="headerlink" href="#python" title="Permanent link">&para;</a></h3>
<p>To ensure a consistent Python code style, we use <a href="https://docs.astral.sh/ruff/">Ruff</a> for both linting and formatting. The official docs contain a guide on <a href="https://docs.astral.sh/ruff/integrations/">editor integration</a>.</p>
<p>Our configuration can be found in <a href="https://github.com/bakdata/kpops">KPOps</a>' top-level <code>pyproject.toml</code>.</p>
<h3 id="markdown">Markdown<a class="headerlink" href="#markdown" title="Permanent link">&para;</a></h3>
<p>To ensure a consistent markdown style, we use <a href="https://dprint.dev">dprint</a>'s <a href="https://dprint.dev/plugins/markdown/">Markdown code formatter</a>. Our configuration can be found <a href="https://github.com/bakdata/kpops/blob/main/dprint.json">here</a>.</p>
<h3 id="css">CSS<a class="headerlink" href="#css" title="Permanent link">&para;</a></h3>
<p>To ensure a consistent CSS style, we use the <a href="https://github.com/g-plane/malva">malva</a> <a href="https://dprint.dev">dprint</a>'s plugin. Our configuration can be found <a href="https://github.com/bakdata/kpops/blob/main/dprint.json">here</a>.</p>
<h3 id="toml">TOML<a class="headerlink" href="#toml" title="Permanent link">&para;</a></h3>
<p>To ensure a consistent TOML style, we use <a href="https://dprint.dev">dprint</a>'s <a href="https://dprint.dev/plugins/toml/">TOML code formatter</a>. Our configuration can be found <a href="https://github.com/bakdata/kpops/blob/main/dprint.json">here</a>.</p>
<p>We advise that you stick to our Git hooks for code linting, formatting, and auto-generation of documentation. After you install them using <code>lefthook install</code> they're triggered automatically during <code>git</code> operations, such as commit or checkout. Additionally, you can manually invoke them with <code>lefthook run pre-commit --all-files</code>. Please also install the <a href="https://dprint.dev/"><code>dprint</code></a> formatter.</p>



Expand Down
2 changes: 1 addition & 1 deletion main/search/search_index.json
View file

Large diffs are not rendered by default.

0 comments on commit cef70d0

Please sign in to comment.