Skip to content

Commit 4ba49f5

Browse files
committed
Fix identation and adding table of contents
1 parent b2876dd commit 4ba49f5

File tree

1 file changed

+21
-3
lines changed

1 file changed

+21
-3
lines changed

README.rst

Lines changed: 21 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,24 @@ PyMAPDL
2929
:alt: black
3030

3131

32+
## Table of contents
33+
34+
<!--ts-->
35+
* [Overview](#overview)
36+
* [Documentation and issues](#documentation-and-issues)
37+
* [Project Transition - Legacy Support](#project-transition---legacy-support)
38+
* [Installation](#installation)
39+
* [Offline Installation](#offline-installation)
40+
* [Dependencies](#dependencies)
41+
* [Getting Started](#getting-started)
42+
* [Launch MAPDL Locally](#launch-mapdl-locally)
43+
* [Launching Manually or Connecting to a Remote Instance](#launching-manually-or-connecting-to-a-remote-instance)
44+
* [Basic Usage](#basic-usage)
45+
* [Run on Docker](#run-on-docker)
46+
* [Citing this Module](#citing-this-module)
47+
* [License and Acknowledgments](#license-and-acknowledgments)
48+
<!--te-->
49+
3250
Overview
3351
--------
3452
The PyMAPDL project supports Pythonic access to MAPDL to be able to
@@ -80,9 +98,9 @@ many steps have been taken to ensure compatibility with legacy code
8098
while supporting new features. The original python module has been
8199
split up into the following projects and modules:
82100

83-
- `ansys.mapdl.core <https://github.com/pyansys/pymapdl>`_
84-
- `ansys.mapdl.reader <https://github.com/pyansys/pymapdl-reader>`_
85-
- `ansys.mapdl.corba <https://github.com/pyansys/pymapdl-corba>`_
101+
- `ansys.mapdl.core <https://github.com/pyansys/pymapdl>`_
102+
- `ansys.mapdl.reader <https://github.com/pyansys/pymapdl-reader>`_
103+
- `ansys.mapdl.corba <https://github.com/pyansys/pymapdl-corba>`_
86104

87105
Please visit the GitHub pages for further details regarding each project.
88106

0 commit comments

Comments
 (0)