.. Simply reuse the root readme .. include:: ../../README.rst Start here ---------- .. grid:: 2 .. grid-item-card:: :octicon:`list-unordered` What is PyAnsys? :link: getting-started/index :link-type: doc An introduction to the PyAnsys project and its ecosystem. .. grid-item-card:: :octicon:`law` Project approval and release :link: getting-started/administration :link-type: doc Steps to authorize the public release of a PyAnsys library. Build and maintain ------------------ .. grid:: 2 .. grid-item-card:: :octicon:`list-unordered` How-to :link: how-to/index :link-type: doc Step-by-step guidelines. .. grid-item-card:: :octicon:`repo` Abstractions :link: abstractions/index :link-type: doc Explanations of the PyAnsys architecture. Style reference --------------- .. grid:: 3 .. grid-item-card:: :octicon:`file-directory` Packaging style :link: packaging/index :link-type: doc Best practices for distributing Python code. .. grid-item-card:: :octicon:`codespaces` Coding style :link: coding-style/index :link-type: doc Best practices for writing Python code. .. grid-item-card:: :octicon:`pencil` Documentation style :link: doc-style/index :link-type: doc Best practices for writing documentation. Contribute to the documentation ------------------------------- .. grid:: 3 .. grid-item-card:: :octicon:`book` Documentation for documentarians :link: content-writing/index :link-type: doc Guidance for writing and revising PyAnsys documentation content. .. grid-item-card:: :octicon:`beaker` General examples :link: examples/index :link-type: doc Gallery examples and templates used with Sphinx-Gallery documentation. .. grid-item-card:: :octicon:`code` Documentation for developers :link: how-to/documenting :link-type: doc Documentation setup, build, deployment, and maintenance workflows. .. toctree:: :hidden: :maxdepth: 2 getting-started/index how-to/index style-reference abstractions/index content-writing/index