RSS

Demo sphinx material

• Theme sphinx-material (A material-based, responsive theme inspired by mkdocs-material)
  • Installation
  • Examples
    • Examples
  • Admonitions
    • Admonitions
    • sidenotes
    • marginnotes
  • Versions
    • Versions
• L’extension sphinx-design (for designing beautiful, screen-size responsive web components)
  • Installation
  • tabs (Onglets)
    • Introduction
    • Example from ray code (1)
    • Example from ray code (2)
    • Synchronised Tabs
    • Example from ray code ray-cluster-configuration
  • badges
    • bdg:plain badge
    • bdg-primary:primary
    • bdg-secondary:secondary
    • bdg-success:success
    • bdg-info:info
    • bdg-warning:warning
    • bdg-danger:danger
    • :bdg-light:light
    • :bdg-dark:dark
    • bdg-link-primary
    • bdg-link-primary-line
  • icons
    • Description
    • Octicon Icons
    • Material Design Icons
  • buttons
    • Introduction
    • button-link
    • button-link with text
    • button-link with text, color and shadow
    • button-link with text, color and outline
    • button-link with text, color and expand
  • cards
    • Cards Clickable
  • grids
    • Introduction
    • Placing a card in a grid
    • Show some sphinx-extensions
    • Example from ray code use-cases.rst
  • Dropdowns (champ déroulant)
    • Description
    • Example
    • Example from ray code (batch_inference.rst)
    • Example from ray code (trainers.rst)
  • additional
    • Description
    • article-info
• Configuration de ce projet sphinx
• Produire la documentation HTML grâce à l’intégration continue de gitlab
  • Le fichier gitlab-ci.yml
  • Sélection du runner “documentation”
  • URL de la documentation produite (https://informatique.gitlab.srv.int.id3.eu/intranet/demo-sphinx)
  • Bonne pratique gitlab : placer l’URL dans la description du projet gitlab
• Extensions sphinx
  • Extension intégrée intersphinx (Link to other projects’ documentation)
    • Utilisation
    • Description
    • Exemples de liens sur les 2 documentations sphinx [« tuto_doc », « ray »]
    • Tips
  • myst-parser
    • Introduction
    • Configuration
    • Convertisseur de .rst à markdown
  • nb-sphinx
  • sphinxcontrib-youtube (A Sphinx extension to embed videos from YouTube and vimeo)
    • Installation
    • Example
    • Getting started
    • Installation
    • HTML
    • LaTeX
  • sphinx-copybutton (Add a « copy » button to code blocks in Sphinx )
    • Installation
  • sphinx-subfigure
    • Usage
    • Options
    • More Examples
• FAQ sphinx
  • Comment enlever le “Show source” à droite ?
  • Où peut-on trouver la liste des thèmes sphinx ?
  • Quels sont les thèmes les plus employés ?
  • Quel est le thème employé sur ce site ?
  • Comment créer la page d’index ?
    • index
    • glossary
  • Quels sont les documentations sphinx qui peuvent servir d’exemples ?
  • Où peut-on trouver la liste des extensions shinx ?
  • Quel est l’intérêt de literalinclude ?
  • Comment paramétrer une substitution ?
  • Est-ce que la langue est paramètrable ?
• Input formats
  • reStructuredText (reSt)
• tools
  • yed + vrt network extensions
    • Installation des graphiques vrt dans les palettes de yed
    • Example arsouyes
• Glossaire (tiré de face SDK)