docs: port documentation to Markdown with Zensical theme#1073
docs: port documentation to Markdown with Zensical theme#1073SaboniAmine merged 30 commits intomasterfrom
Conversation
- 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
|
Thanks for this @davidberenstein1957 ! Maybe update as well the |
- 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>
- .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 Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #1073 +/- ##
=======================================
Coverage 78.19% 78.19%
=======================================
Files 38 38
Lines 3637 3637
=======================================
Hits 2844 2844
Misses 793 793 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
|
@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 :) |
|
Thanks David, |
@benoit-cty I think if someone changes a RST file that has been deleted by this branch it will show as a git conflict. Maybe we are good as long as we solve those conflicts properly |
|
We can use this one as a test #1078, we merge it and it should throw some conflicts in this branch. Then we have nothing to worry about. (I don't mind doing a version of those changes in md as well later). |
- Included instructions for downloading and running a standalone installer using curl for Unix-based systems and PowerShell for Windows users. - Updated command line section header to include an anchor for easier navigation.
|
@inimaz @benoit-cty I understand your concern. I've checked before, and I've resolved the conflict to Either way, I used an agent to check the RST against the markdown, and there don't seem to be any changes against the markdown besides some functional changes to include small Ecologits references. I'm not 100% about the GitHub workflows working correctly for deployment and versioning, so this might need some minor iteration after merging. |
- Introduced `build-docs.yml` to automate Sphinx and Zensical documentation builds on push and pull request events. - Added `deploy-docs.yml` for deploying documentation to GitHub Pages with versioning on master branch pushes and release events. - Configured Python environment and dependencies for both workflows.
…mmand - Added the path for `scripts/deploy-docs.sh` to the workflow triggers. - Corrected the pip installation command by removing the 'uv' prefix for clarity.
…mmand - Added the path for `scripts/deploy-docs.sh` to the trigger paths in `deploy-docs.yml`. - Corrected the command to install dependencies from `uv pip install` to `pip install` for proper execution.
…ocess - Consolidated Sphinx and Zensical build steps into a single job. - Updated paths to trigger on changes to `mkdocs.yml` instead of `zensical.toml`. - Replaced Sphinx build commands with Zensical commands for documentation generation. - Adjusted Python version setup and dependency installation using `uv` for improved compatibility.
- Added permissions for read access in `build-docs.yml` and adjusted the build command to use `uv run`. - Updated `deploy-docs.yml` to set permissions for write access and modified the version retrieval command to utilize `uv run` for consistency in execution.
inimaz
left a comment
There was a problem hiding this comment.
Thanks for this @davidberenstein1957 , I like a lot the feel.
I think some hallucinations went through though check some of the comments.
SaboniAmine
left a comment
There was a problem hiding this comment.
Looks good! In addition to missing sections Inigo identified, some ajustments on the content
- usage.md: remove def_list colon, fix indentation, remove escaping - comet.md, api.md: remove unnecessary escaping - rapl.md: fix Threadripper measurements formatting - output.md: add CodeCarbon API and Logfire sections - faq.md: update API data answer, link to methodology for hardware - mkdocs.yml: edit_uri master, Parameters nav label, add test_on_scaleway Made-with: Cursor
- Removed `grafana_token` parameter from the parameters table in `parameters.md`. - Corrected formatting inconsistencies in `methodology.md` and `visualize.md`, including adjustments to bullet points and mathematical expressions for clarity.
- Added mkdocstrings plugin for improved documentation generation with Python support. - Updated navigation in mkdocs.yml to include the Parameters section. - Enhanced parameter descriptions in emissions_tracker.py for clarity and consistency. - Corrected minor typos in API and parameters documentation. - Introduced new check-docs-drift script in pyproject.toml for documentation consistency checks.
- Added `setuptools` to the `dev` dependencies in `pyproject.toml` for improved package management. - Updated `uv.lock` to include specific versions of `setuptools` based on Python version compatibility. - Modified `build-docs.yml` to restrict branch triggers to `master` only, simplifying the workflow.
SaboniAmine
left a comment
There was a problem hiding this comment.
LGTM, a minor formatting issue remains, but after that I guess it could be merged!
We can easily merge patches if something was missing anyway
…928-md docs(quickstart): port login + no-api guidance to markdown docs
- Added new lines in `check_powerstat_approach.py`, `intel_rapl_show.py`, `test_default_dram.py`, `test_dram_option.py`, `test_rapl_domains.py`, and `test_rapl_fix.py` for better code organization and readability. - Fixed formatting in `emissions_tracker.py` to ensure consistent spacing in parameter documentation.
Summary
Port CodeCarbon documentation from reStructuredText (.rst) to Markdown (.md) with Zensical theme.
Changes
Branding
Files Changed
Verification
Build docs with:
uv run task docs