upstream/ipython Files · IPython/terminal/tests/test_help.py

Improve API documentation around configuration of embedded IPython (#13989)...

Improve API documentation around configuration of embedded IPython (#13989) This PR tries to improve the API documentation of `embed()`, `embed_kernel()`, `start_ipython()` and `start_kernel()` with respect to the configuration of IPython by adding links to other sections of the documentation. It also reorganizes the API docs so that `embed()` is listed under `IPython`, just as it's presented in the narrative documentation.

Nikita Kniazev - - Load All Authors

File last commit:

r27104:eac76a50


                r28197:ad452c1d

Download file

             test_help.py
        
                    30 lines
            
             | 722 B
            
                | text/x-python
            
             |
                PythonLexer
            
             / IPython / terminal / tests / test_help.py
          
                    History
                
                 |
                  Annotation
                 | Raw
                 |Copy content
                 |Copy permalink

      """Test help output of various IPython entry points"""

      # Copyright (c) IPython Development Team.

      # Distributed under the terms of the Modified BSD License.

      import pytest

      import IPython.testing.tools as tt

      def test_ipython_help():

          tt.help_all_output_test()

      def test_profile_help():

          tt.help_all_output_test("profile")

      def test_profile_list_help():

          tt.help_all_output_test("profile list")

      def test_profile_create_help():

          tt.help_all_output_test("profile create")

      def test_locate_help():

          tt.help_all_output_test("locate")

      def test_locate_profile_help():

          tt.help_all_output_test("locate profile")

      def test_trust_help():

          pytest.importorskip("nbformat")

          tt.help_all_output_test("trust")

	Site-wide shortcuts
/	Use quick search box
g h	Goto home page
g g	Goto my private gists page
g G	Goto my public gists page
g 0-9	Goto bookmarked items from 0-9
n r	New repository page
n g	New gist page

	Repositories
g s	Goto summary page
g c	Goto changelog page
g f	Goto files page
g F	Goto files page with file search activated
g p	Goto pull requests page
g o	Goto repository settings
g O	Goto repository access permissions settings
t s	Toggle sidebar on some pages

				"""Test help output of various IPython entry points"""

				# Copyright (c) IPython Development Team.
				# Distributed under the terms of the Modified BSD License.

				import pytest
				import IPython.testing.tools as tt


				def test_ipython_help():
				tt.help_all_output_test()

				def test_profile_help():
				tt.help_all_output_test("profile")

				def test_profile_list_help():
				tt.help_all_output_test("profile list")

				def test_profile_create_help():
				tt.help_all_output_test("profile create")

				def test_locate_help():
				tt.help_all_output_test("locate")

				def test_locate_profile_help():
				tt.help_all_output_test("locate profile")

				def test_trust_help():
				pytest.importorskip("nbformat")
				tt.help_all_output_test("trust")