Skip to content

Commit e82965b

Browse files
move contributing section into the getting started section (#1829)
* move contributing section into the getting started section * changes layout * Update doc/source/getting_started/index.rst Co-authored-by: Paul Profizi <[email protected]> * Update doc/source/conf.py Co-authored-by: Paul Profizi <[email protected]> --------- Co-authored-by: Paul Profizi <[email protected]>
1 parent c673ed3 commit e82965b

File tree

4 files changed

+7
-5
lines changed

4 files changed

+7
-5
lines changed

doc/source/conf.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,8 @@
9191

9292
redirects = {
9393
"user_guide/getting_started_with_dpf_server": "../getting_started/dpf_server.html",
94-
"concepts/index": "../user_guide/index.html#concepts"
94+
"concepts/index": "../user_guide/index.html#concepts",
95+
"contributing": "getting_started/contributing.html"
9596
}
9697

9798
typehints_defaults = "comma"

doc/source/contributing.rst renamed to doc/source/getting_started/contributing.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
.. _contributing:
22

3-
==========
4-
Contribute
5-
==========
3+
============
4+
Contributing
5+
============
66

77
Overall guidance on contributing to a PyAnsys repository appears in
88
`Contribute <https://dev.docs.pyansys.com/overview/contributing.html>`_

doc/source/getting_started/index.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -111,11 +111,13 @@ To use PyDPF-Core, in the same Python environment, run this command:
111111

112112

113113
.. toctree::
114+
:maxdepth: 2
114115
:hidden:
115116

116117
install
117118
dpf_server
118119
compatibility
119120
licensing
120121
dependencies
122+
contributing
121123

doc/source/index.rst

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -193,4 +193,3 @@ To reach the project support team, email `[email protected] <pyansys.core@a
193193
examples/index
194194
api/index
195195
operator_reference
196-
contributing

0 commit comments

Comments
 (0)