Skip to content

Commit 2bef1d3

Browse files
committed
added basic getting help pages
1 parent 773a9ea commit 2bef1d3

File tree

3 files changed

+21
-0
lines changed

3 files changed

+21
-0
lines changed

doc/get_help/faqs.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Frequently Asked Questions
2+
3+
## `get_spacings` returns an error
4+
5+
This is one of the most common *tobac* issues for new users.

doc/get_help/index.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Getting Help
2+
3+
```{toctree}
4+
:hidden: false
5+
:maxdepth: 3
6+
7+
faqs
8+
```
9+
10+
11+
*tobac* can be challenging to use, especially for those not familiar with the Python/SciPy ecosystem. While we strive for robust documentation, this is sometimes not enough or not helpful. We've created this set of pages to help guide you to the best ways to get help.
12+
13+
We encourage you to look through the [Example Gallery](../examples/index) and the [Frequently Asked Questions](./faqs) pages to see if either of those can help resolve your issue.
14+
15+
The developers of *tobac*, from the lead developers to individual contributors, want you to have success in your research and in using this package. We **strongly encourage** you to reach out if you encounter any difficulty.

doc/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -243,6 +243,7 @@ or, if you are using features introduced from v1.5.0 or above, please also cite
243243
Getting Started<getting_started/index>
244244
Example Gallery<examples/index>
245245
User Guide<userguide/index>
246+
Get Help<get_help/index>
246247
Developer Guide<developer_guide/index>
247248
API <api/index>
248249
:::

0 commit comments

Comments
 (0)