Skip to content

Comments

docs: port documentation to Markdown with Zensical theme#1073

Open
davidberenstein1957 wants to merge 15 commits intomasterfrom
docs/port-to-zensical
Open

docs: port documentation to Markdown with Zensical theme#1073
davidberenstein1957 wants to merge 15 commits intomasterfrom
docs/port-to-zensical

Conversation

@davidberenstein1957
Copy link

Summary

Port CodeCarbon documentation from reStructuredText (.rst) to Markdown (.md) with Zensical theme.

Changes

  • Convert all RST docs to Markdown format
  • Add configuration
  • Use CodeCarbon teal branding (matching logo)
  • Fix index.md formatting
  • Add proper headers and structure matching original RST

Branding

  • Primary color: teal (CodeCarbon's brand color)
  • Accent color: teal
  • Dark/light mode support enabled

Files Changed

  • docs/*.md (19 files)
  • docs/zensical.yml (new)
  • zensical.toml (new)

Verification

Build docs with: uv run task docs

- Convert RST docs to Markdown format
- Add zensical.yml configuration
- Use CodeCarbon teal branding (matching logo)
- Fix index.md formatting
- Add proper headers and structure matching original RST
@davidberenstein1957 davidberenstein1957 requested a review from a team as a code owner February 21, 2026 06:45
@inimaz
Copy link
Collaborator

inimaz commented Feb 21, 2026

Thanks for this @davidberenstein1957 ! Maybe update as well the pyproject.toml with the new deps? If I run uv run task docs it still builds the sphinx documentation

@davidberenstein1957 davidberenstein1957 marked this pull request as draft February 21, 2026 09:35
davidberenstein1957 and others added 12 commits February 22, 2026 22:53
- Added deployment directory to .gitignore
- Updated CONTRIBUTING.md to reflect changes in documentation structure
- Replaced Sphinx with Zensical for documentation generation
- Updated README and other documentation files to align with new structure
- Removed obsolete zensical.toml and related files
- Adjusted build commands in pyproject.toml for Zensical integration
* feat: add missing oidc auth on cli

* fix: add authlib to core dependencies

fix: fix tests

* test: add auth tests for the cli

---------

Co-authored-by: Amine Saboni <saboni.amine@gmail.com>
Co-authored-by: inimaz <93inigo93@gmail.com>
* fix(api): logout flow in the dashboard

* fix:allow only authenticated users to logout

* test: fix test_authenticate

* fix: move create_redirect_response to auth_provider
Resolve conflicts:
- CONTRIBUTING.md: keep nested TOC and Zensical doc instructions
- docs: remove old Sphinx-generated files, keep Zensical structure
- pyproject.toml: keep zensical+mike for doc deps
- uv.lock: regenerated with zensical/mike deps

Co-authored-by: Cursor <cursoragent@cursor.com>
@davidberenstein1957 davidberenstein1957 marked this pull request as ready for review February 22, 2026 22:00
davidberenstein1957 and others added 2 commits February 22, 2026 23:05
- .github/pyproject_versions.py: remove extra blank line (isort)
- test_emissions_tracker_constant: widen cpu_load tolerance to 350
  (post-test cpu_percent can differ from during-test load)

Co-authored-by: Cursor <cursoragent@cursor.com>
…sions_tracker_constant

- Updated the assertion for cpu_power to improve code clarity by breaking it into multiple lines.
@codecov
Copy link

codecov bot commented Feb 22, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 78.14%. Comparing base (b370a5a) to head (30c16a3).

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #1073   +/-   ##
=======================================
  Coverage   78.14%   78.14%           
=======================================
  Files          38       38           
  Lines        3637     3637           
=======================================
  Hits         2842     2842           
  Misses        795      795           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@davidberenstein1957
Copy link
Author

@inimaz @claude @SabAmine @benoit-cty do you guys have some time to take a look? I did not change much content wise(this will happen in another pr), but mostly ported things to Zensical and make it 2026 ready :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants