Skip to content

documented code#16

Merged
ArthurDanjou merged 59 commits into
mainfrom
documented_code
Apr 30, 2026
Merged

documented code#16
ArthurDanjou merged 59 commits into
mainfrom
documented_code

Conversation

@pevab
Copy link
Copy Markdown
Collaborator

@pevab pevab commented Apr 28, 2026

  • Adding configuration file for sphinx
  • Working on doc
  • Working on aggregators doc
  • compiling doc
  • working on aggregators doc
  • Rework index page and doc structure
  • Fix build of the table in architecture.rst
  • working on attacks doc
  • Improve docstring in init.py for attacks and aggregators
  • Fixing duplicated texts
  • Fix formatting in documentation for aggregators index.rst by removing extra whitespace
  • Compile last modifs
  • Add watch command to makefile
  • Remove undoc-members
  • add tools documentation
  • Try new theme
  • Remove custom sidebar configuration from Sphinx documentation settings
  • Try new theme
  • add typing for tools
  • Working on aggregators doc: improve the examples
  • working on doc
  • Convert misc.py to the numpy/rest docstring format
  • Convert misc.py to the numpy/reST docstring format
  • Uniformisation of the docstrings
  • Add typing and format docstring
  • built doc with last modifications
  • Uniformise docstrings
  • fix duplicata
  • Fix de la cohérence
  • Add references between pages
  • Improving index, architecture and native pages
  • Improve experiments docs and docstrings
  • Add seealso and last docstring
  • Document and refactor experiments API and docs
  • Reformat headers and function signatures with ruff
  • Format code with ruff
  • Add description for how to add an external dataset/model and how to register it
  • Improve docstring in built-in datasets and models
  • Add docs CI workflow and update .gitignore
  • Change branch name in workflow
  • Update searchindex.js

@pevab pevab linked an issue Apr 28, 2026 that may be closed by this pull request
Comment thread .github/workflows/documentation.yml
Comment thread .gitignore Outdated
Comment thread README.md
Comment thread README.md
@ArthurDanjou ArthurDanjou added the documentation Improvements or additions to documentation label Apr 29, 2026
@ArthurDanjou
Copy link
Copy Markdown
Collaborator

Fix du build de la doc.
Il reste juste à activer Pages et sélectionner "GitHub Actions" comme source. Pas besoin de configurer de branche ou de dossier, le workflow s'en charge avec upload-pages-artifact et deploy-pages (@srlt pour les permissions)

@ArthurDanjou ArthurDanjou changed the base branch from preexist to main April 30, 2026 15:05
@ArthurDanjou ArthurDanjou merged commit e1da136 into main Apr 30, 2026
1 of 2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Documentation du code existant

2 participants