Skip to content

move contributing section into the getting started section #1829

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Oct 24, 2024
Merged

move contributing section into the getting started section #1829

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
df447ef
move contributing section into the getting started section
luisaFelixSalles Oct 23, 2024
8d09375
changes layout
luisaFelixSalles Oct 23, 2024
38f1c97
Update doc/source/getting_started/index.rst
luisaFelixSalles Oct 23, 2024
3e703d1
Update doc/source/conf.py
luisaFelixSalles Oct 23, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion doc/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,8 @@

redirects = {
"user_guide/getting_started_with_dpf_server": "../getting_started/dpf_server.html",
"concepts/index": "../user_guide/index.html#concepts"
"concepts/index": "../user_guide/index.html#concepts",
"contributing": "getting_started/contributing.html"
}

typehints_defaults = "comma"
Expand Down
6 changes: 3 additions & 3 deletions doc/source/contributing.rst → doc/source/getting_started/contributing.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
.. _contributing:

==========
Contribute
==========
============
Contributing
============

Overall guidance on contributing to a PyAnsys repository appears in
`Contribute <https://dev.docs.pyansys.com/overview/contributing.html>`_
Expand Down
2 changes: 2 additions & 0 deletions doc/source/getting_started/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,11 +111,13 @@ To use PyDPF-Core, in the same Python environment, run this command:


.. toctree::
:maxdepth: 2
:hidden:

install
dpf_server
compatibility
licensing
dependencies
contributing

1 change: 0 additions & 1 deletion doc/source/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -193,4 +193,3 @@ To reach the project support team, email `[email protected] <pyansys.core@a
examples/index
api/index
operator_reference
contributing
Loading