Skip to content

Commit f6ae3b7

Browse files
committed
[docs] rename tutorial to tutorial and building to build
1 parent 63d7b00 commit f6ae3b7

File tree

16 files changed

+19
-18
lines changed

16 files changed

+19
-18
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -663,6 +663,7 @@ src/ipc/config.hpp
663663
tests/src/tests/config.hpp
664664

665665
docs/_doxygen
666+
!docs/source/build
666667

667668
notebooks/*.[ch]pp
668669
python/update_bindings.py

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ This is not a full simulation library. As such it does not include any physics o
2828

2929
## Build
3030

31-
Instruction for building and including the IPC Toolkit in your CMake project can be found on the website [here](https://ipctk.xyz/building.html).
31+
Instruction for building and including the IPC Toolkit in your CMake project can be found on the website [here](https://ipctk.xyz/build.html).
3232

3333
### Dependencies
3434

@@ -46,7 +46,7 @@ For more information see the [Python documentation](https://ipctk.xyz/python.htm
4646

4747
## Usage
4848

49-
See the [tutorial](https://ipctk.xyz/tutorial/getting_started.html) for a quick introduction to the toolkit, or the [documentation](https://ipctk.xyz/cpp-api/potentials.html) for a full reference.
49+
See the [tutorials](https://ipctk.xyz/tutorials/getting_started.html) for a quick introduction to the toolkit, or the [documentation](https://ipctk.xyz/cpp-api/potentials.html) for a full reference.
5050

5151
## Contributing
5252

docs/PYPI_README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ pip install git+https://github.com/ipc-sim/ipc-toolkit
3838

3939
## Help/Documentation
4040

41-
* A tutorial on how to use the toolkit can be found [here](https://ipctk.xyz/tutorial/getting_started.html).
41+
* Tutorials on how to use the toolkit can be found [here](https://ipctk.xyz/tutorials/getting_started.html).
4242
* A function reference can be found [here](https://ipctk.xyz/python.html).
4343

4444
## Contributing
File renamed without changes.
File renamed without changes.

docs/source/index.rst

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -8,25 +8,25 @@
88
about/dependencies.rst
99

1010
.. toctree::
11-
:caption: Building
11+
:caption: Build
1212
:hidden:
1313

14-
Library <building/building.rst>
15-
building/python.rst
14+
Library <build/c++.rst>
15+
build/python.rst
1616

1717
.. toctree::
18-
:caption: Tutorial
18+
:caption: Tutorials
1919
:hidden:
2020

21-
tutorial/getting_started.rst
22-
tutorial/advanced_friction.rst
23-
tutorial/convergent.rst
24-
tutorial/nonlinear_ccd.rst
25-
tutorial/adhesion.rst
26-
tutorial/simulation.rst
27-
tutorial/misc.rst
28-
tutorial/faq.rst
29-
tutorial/references.rst
21+
tutorials/getting_started.rst
22+
tutorials/advanced_friction.rst
23+
tutorials/convergent.rst
24+
tutorials/nonlinear_ccd.rst
25+
tutorials/adhesion.rst
26+
tutorials/simulation.rst
27+
tutorials/misc.rst
28+
tutorials/faq.rst
29+
tutorials/references.rst
3030

3131
.. toctree::
3232
:caption: C++ API
@@ -119,7 +119,7 @@ This is not a full simulation library. As such it does not include any physics o
119119

120120
**Usage**
121121

122-
See the `tutorial <https://ipctk.xyz/tutorial/getting_started.html>`_ for a quick introduction to the toolkit, or the `documentation <https://ipctk.xyz/cpp.html>`_ for a full reference.
122+
See the `tutorials <https://ipctk.xyz/tutorials/getting_started.html>`_ for a quick introduction to the toolkit, or the `documentation <https://ipctk.xyz/cpp.html>`_ for a full reference.
123123

124124
**Python Bindings**
125125

File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)