Skip to content
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.

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

add help page to docs and update README #1377

Merged
merged 4 commits into from
Sep 12, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
19 changes: 15 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,15 +71,26 @@ pip install nbconvert[test]
py.test --pyargs nbconvert
```

## Resources
## Documentation

- [Documentation for Jupyter nbconvert](https://nbconvert.readthedocs.io/en/latest/)
[[PDF](https://media.readthedocs.org/pdf/nbconvert/latest/nbconvert.pdf)]
- [nbconvert examples on GitHub](https://github.com/jupyter/nbconvert-examples)
- [Issues](https://github.com/jupyter/nbconvert/issues)
- [Technical support - Jupyter Google Group](https://groups.google.com/forum/#!forum/jupyter)
- [Project Jupyter website](https://jupyter.org)
- [Documentation for Project Jupyter](https://jupyter.readthedocs.io/en/latest/index.html)
[[PDF](https://media.readthedocs.org/pdf/jupyter/latest/jupyter.pdf)]

## Technical Support

- [Issues and Bug Reports](https://github.com/jupyter/nbconvert/issues): A place to report
bugs or regressions found for nbconvert
- [Community Technical Support and Discussion - Discourse](https://discourse.jupyter.org/): A place for
installation, configuration, and troubleshooting assistannce by the Jupyter community.
As a non-profit project and maintainers who are primarily volunteers, we encourage you
to ask questions and share your knowledge on Discourse.

## Jupyter Resources

- [Jupyter mailing list](https://groups.google.com/forum/#!forum/jupyter)
- [Project Jupyter website](https://jupyter.org)

[Jinja]: http://jinja.pocoo.org/
7 changes: 2 additions & 5 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -65,13 +65,10 @@ batch of notebook files to another format.
changelog

.. toctree::
:maxdepth: 1
:maxdepth: 2
:caption: Questions? Suggestions?

Jupyter mailing list <https://groups.google.com/forum/#!forum/jupyter>
Jupyter website <https://jupyter.org>
Stack Overflow - Jupyter <https://stackoverflow.com/questions/tagged/jupyter>
Stack Overflow - Jupyter-notebook <https://stackoverflow.com/questions/tagged/jupyter-notebook>
need_help

Indices and tables
==================
Expand Down
26 changes: 26 additions & 0 deletions docs/source/need_help.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
Need help?
==========

Technical Support
-----------------

- `GitHub Issues and Bug Reports <https://github.com/jupyter/nbconvert/issues>`_: A
place to report bugs or regressions found for nbconvert
- `Community Technical Support and Discussion - Jupyter Discourse <https://discourse.jupyter.org/>`_:
A place for installation, configuration, and troubleshooting assistance by the Jupyter community.
As a non-profit project with maintainers who are primarily volunteers, we rely on the community
for technical support. Please use Discourse to ask questions and share your knowledge.

Documentation
-------------

- `Documentation for Jupyter nbconvert <https://nbconvert.readthedocs.io/en/latest/>`_
`PDF <https://media.readthedocs.org/pdf/nbconvert/latest/nbconvert.pdf>`_
- `nbconvert examples repo on GitHub <https://github.com/jupyter/nbconvert-examples>`_
- `Documentation for Project Jupyter <https://jupyter.readthedocs.io/en/latest/index.html>`_

Jupyter Resources
-----------------

- `Jupyter mailing list <https://groups.google.com/forum/#!forum/jupyter>`_
- `Project Jupyter website <https://jupyter.org>`_