Code

New Doc Style Guide#85

Code

Merged

jorgepiloto merged 14 commits intomainansys/pyansys-dev-guide:mainfrom

feat/doc_styleansys/pyansys-dev-guide:feat/doc_styleCopy head branch name to clipboard

May 18, 2022

Commits

Commits on May 13, 2022

• Move documentation_style/ -> doc-style/

  jorgepiloto

  committed
  06d4cb4

  Copy full SHA for 06d4cb4

• Update API Documentation Style -> Documentation Style

  jorgepiloto

  committed
  1e208b0

  Copy full SHA for 1e208b0

• Fix pydocstyle configuration

  jorgepiloto

  committed
  25669c0

  Copy full SHA for 25669c0

• Reformat docstrings.rst file

  jorgepiloto

  committed
  dc1ddae

  Copy full SHA for dc1ddae

• Remove duplicated section about doc deployment

  jorgepiloto

  committed
  cbaa8b0

  Copy full SHA for cbaa8b0

• Move numpydoc validation to doc formatting tools

  jorgepiloto

  committed
  1b207bd

  Copy full SHA for 1b207bd

• Apply suggestions from code review

  Show description for 019b46a
  

  jorgepiloto

  and

  PipKat

  committed
  019b46a

  Copy full SHA for 019b46a

• Remove 'how to class documentation' from doc style

  jorgepiloto

  committed
  b72c5e0

  Copy full SHA for b72c5e0

• Improve docstrings layout

  jorgepiloto

  committed
  0fcdecf

  Copy full SHA for 0fcdecf

• Add doc generation in how to

  jorgepiloto

  committed
  9fc4508

  Copy full SHA for 9fc4508

Commits on May 16, 2022

• Update doc/source/doc-style/docstrings.rst

  Show description for f779ca2
  

  jorgepiloto

  and

  MaxJPRey

  authored
  f779ca2

  Copy full SHA for f779ca2

• Add blacken-docs to formatting-tools

  jorgepiloto

  committed
  5ba7308

  Copy full SHA for 5ba7308

Commits on May 18, 2022

• Apply code suggestions

  jorgepiloto

  committed
  1756c33

  Copy full SHA for 1756c33

• Clarify parameters section

  Show description for 77cf95f
  

  jorgepiloto

  and

  PipKat

  authored
  77cf95f

  Copy full SHA for 77cf95f