Skip to content

Commit bf342ab

Browse files
formanforman
committed
Deployed 022a545 with MkDocs version: 1.6.1
1 parent 793564a commit bf342ab

File tree

5 files changed

+196
-6
lines changed

5 files changed

+196
-6
lines changed

‎about/index.html‎

Lines changed: 169 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,11 @@
7373
<label class="md-overlay" for="__drawer"></label>
7474
<div data-md-component="skip">
7575

76+
77+
<a href="#changes" class="md-skip">
78+
Skip to content
79+
</a>
80+
7681
</div>
7782
<div data-md-component="announce">
7883

@@ -347,6 +352,17 @@
347352

348353

349354

355+
<label class="md-nav__link md-nav__link--active" for="__toc">
356+
357+
358+
<span class="md-ellipsis">
359+
About
360+
</span>
361+
362+
363+
<span class="md-nav__icon md-icon"></span>
364+
</label>
365+
350366
<a href="./" class="md-nav__link md-nav__link--active">
351367

352368

@@ -357,6 +373,101 @@
357373

358374
</a>
359375

376+
377+
378+
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
379+
380+
381+
382+
383+
<label class="md-nav__title" for="__toc">
384+
<span class="md-nav__icon md-icon"></span>
385+
Table of contents
386+
</label>
387+
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
388+
389+
<li class="md-nav__item">
390+
<a href="#changes" class="md-nav__link">
391+
<span class="md-ellipsis">
392+
Changes
393+
</span>
394+
</a>
395+
396+
</li>
397+
398+
<li class="md-nav__item">
399+
<a href="#reporting" class="md-nav__link">
400+
<span class="md-ellipsis">
401+
Reporting
402+
</span>
403+
</a>
404+
405+
</li>
406+
407+
<li class="md-nav__item">
408+
<a href="#contributions" class="md-nav__link">
409+
<span class="md-ellipsis">
410+
Contributions
411+
</span>
412+
</a>
413+
414+
</li>
415+
416+
<li class="md-nav__item">
417+
<a href="#development" class="md-nav__link">
418+
<span class="md-ellipsis">
419+
Development
420+
</span>
421+
</a>
422+
423+
<nav class="md-nav" aria-label="Development">
424+
<ul class="md-nav__list">
425+
426+
<li class="md-nav__item">
427+
<a href="#testing-and-coverage" class="md-nav__link">
428+
<span class="md-ellipsis">
429+
Testing and Coverage
430+
</span>
431+
</a>
432+
433+
</li>
434+
435+
<li class="md-nav__item">
436+
<a href="#coding-style" class="md-nav__link">
437+
<span class="md-ellipsis">
438+
Coding Style
439+
</span>
440+
</a>
441+
442+
</li>
443+
444+
<li class="md-nav__item">
445+
<a href="#documentation" class="md-nav__link">
446+
<span class="md-ellipsis">
447+
Documentation
448+
</span>
449+
</a>
450+
451+
</li>
452+
453+
</ul>
454+
</nav>
455+
456+
</li>
457+
458+
<li class="md-nav__item">
459+
<a href="#license" class="md-nav__link">
460+
<span class="md-ellipsis">
461+
License
462+
</span>
463+
</a>
464+
465+
</li>
466+
467+
</ul>
468+
469+
</nav>
470+
360471
</li>
361472

362473

@@ -381,7 +492,64 @@
381492

382493
<h1>About</h1>
383494

384-
495+
<h2 id="changes">Changes</h2>
496+
<p>You can find the complete Chartlets changelog
497+
<a href="https://github.com/bcdev/chartlets/blob/main/CHANGES.md">here</a>. </p>
498+
<h2 id="reporting">Reporting</h2>
499+
<p>If you have suggestions, ideas, feature requests, or if you have identified
500+
a malfunction or error, then please
501+
<a href="https://github.com/bcdev/chartlets/issues">post an issue</a>. </p>
502+
<h2 id="contributions">Contributions</h2>
503+
<p>The Chartlets project welcomes contributions of any form
504+
as long as you respect our
505+
<a href="https://github.com/bcdev/chartlets/blob/main/CODE_OF_CONDUCT.md">code of conduct</a>
506+
and follow our
507+
<a href="https://github.com/bcdev/chartlets/blob/main/CONTRIBUTING.md">contribution guide</a>.</p>
508+
<p>If you'd like to submit code or documentation changes, we ask you to provide a
509+
pull request (PR)
510+
<a href="https://github.com/bcdev/chartlets/pulls">here</a>.
511+
For code and configuration changes, your PR must be linked to a
512+
corresponding issue. </p>
513+
<h2 id="development">Development</h2>
514+
<p>To set up the Python development environment, with repository root as
515+
current working directory:</p>
516+
<pre><code class="language-bash">cd chartlets.py
517+
pip install .[dev,doc]
518+
</code></pre>
519+
<h3 id="testing-and-coverage">Testing and Coverage</h3>
520+
<p>Chartlets uses <a href="https://docs.pytest.org/">pytest</a> for unit-level testing
521+
and coverage analysis for its Python code.</p>
522+
<pre><code class="language-bash">cd chartlets.py
523+
pytest --cov=chartlets tests
524+
</code></pre>
525+
<h3 id="coding-style">Coding Style</h3>
526+
<p>Chartlets' Python code is formatted by <a href="https://black.readthedocs.io/">black</a>.</p>
527+
<pre><code class="language-bash">cd chartlets.py
528+
black .
529+
</code></pre>
530+
<p>Chartlets' TypeScript code is formatted by
531+
<a href="https://prettier.io/">prettier</a>.</p>
532+
<pre><code class="language-bash">cd chartlets.js
533+
prettier .
534+
</code></pre>
535+
<h3 id="documentation">Documentation</h3>
536+
<p>Chartlets' documentation is built using the <a href="https://www.mkdocs.org/">mkdocs</a> tool.</p>
537+
<pre><code class="language-bash">cd chartlets.py
538+
pip install .[doc]
539+
cd ..
540+
</code></pre>
541+
<p>With repository root as current working directory:</p>
542+
<pre><code class="language-bash"># Write
543+
mkdocs serve
544+
545+
# Publish
546+
mkdocs build
547+
mkdocs gh-deploy
548+
</code></pre>
549+
<h2 id="license">License</h2>
550+
<p>Chartlets is open source made available under the terms and conditions of the
551+
<a href="https://github.com/bcdev/chartlets/blob/main/LICENSE">MIT License</a>.</p>
552+
<p>Copyright © 2024 Brockmann Consult Development</p>
385553

386554

387555

‎index.html‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -310,6 +310,15 @@
310310
</label>
311311
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
312312

313+
<li class="md-nav__item">
314+
<a href="#features" class="md-nav__link">
315+
<span class="md-ellipsis">
316+
Features
317+
</span>
318+
</a>
319+
320+
</li>
321+
313322
<li class="md-nav__item">
314323
<a href="#how-it-works" class="md-nav__link">
315324
<span class="md-ellipsis">
@@ -429,6 +438,17 @@ <h1 id="welcome-to-chartlets">Welcome to Chartlets</h1>
429438
<p>Chartlets is a software framework that allows websites developed with
430439
React to be extended by server-side widgets programmed in Python or other
431440
programming languages. </p>
441+
<p>It comprises a
442+
<a href="https://github.com/bcdev/chartlets/tree/main/chartlets.py">Python backend package</a>
443+
and a
444+
<a href="https://github.com/bcdev/chartlets/tree/main/chartlets.js">JavaScript/React frontend package</a>.</p>
445+
<h2 id="features">Features</h2>
446+
<ul>
447+
<li>Enhance your React web application by UI-contributions programmed in Python</li>
448+
<li>Enhance your (Python) web API to serve server-side UI-contributions.</li>
449+
<li>Uses <a href="https://mui.com/material-ui/">Material UI</a> components and
450+
<a href="https://vega.github.io/vega-lite/">Vega-Lite</a> charts.</li>
451+
</ul>
432452
<h2 id="how-it-works">How it works</h2>
433453
<p>Users write the widgets in, e.g. Python, and a REST server implements three
434454
endpoints to publish the widgets:</p>

0 commit comments

Comments
 (0)