Skip to content

Instantly share code, notes, and snippets.

@nkpro2000
Created May 25, 2020 17:44
Show Gist options
  • Save nkpro2000/2e3dc9ae0edd94d46b64064217614978 to your computer and use it in GitHub Desktop.
Save nkpro2000/2e3dc9ae0edd94d46b64064217614978 to your computer and use it in GitHub Desktop.
It ease the creation of intelligent and beautiful documentation. (https://www.sphinx-doc.org/en/master/) (https://livesphinx.herokuapp.com/)

All contents

python

python

https://www.python.org

https://www.python.org

python

hi hi

  • hi
  1. hii
  2. hiii
  1. bye

print('Hello world')

print('Hello World')

Python code:

print('hello world')
Header 1 Header 2 Header 3
body row 1 column 2 column 3
body row 2 Cells may span columns.
body row 3 Cells may span rows.
  • Cells
  • contain
  • blocks.
body row 4

Specials:)

.. literalinclude:: filename
   :linenos:
   :language: python
   :lines: 1, 3-5
   :start-after: 3
   :end-before: 5

.. toctree::
   :glob:

   intro*
   recipe/*
   *

.. autofunction:: main

now we can use the longtext many times this is a very very long text to include this is a very very long text to include then a image Logo

.. hlist::
   :columns: 3

   * first item
   * second item
   * 3d item
   * 4th item
   * 5th item

.. seealso:: This is a simple **seealso** note.

Warning

note the space between the directive and the text

Note

This is a note box.

Your Topic Title

Subsequent indented lines comprise the body of the topic, and are interpreted as body elements.

Sidebar Title

Optional Sidebar Subtitle

Subsequent indented lines comprise the body of the sidebar, and are interpreted as body elements.

.. glossary::
     apical
        at the top of the plant.
     hi
        skfsfsfksk
           jdiifsfsdi

name:myname

Some text that requires a footnote [1] .

[1]Text of the first footnote.

[CIT2002]

[CIT2002]A citation (as often used in journals).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment