diff --git a/docs/.gitignore b/docs/.gitignore new file mode 100644 index 0000000..0f5c079 --- /dev/null +++ b/docs/.gitignore @@ -0,0 +1 @@ +_generate/* diff --git a/docs/conf.py b/docs/conf.py index 234d003..a3921a4 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -40,7 +40,7 @@ # The suffix(es) of source filenames. # You can specify multiple suffix as a list of string: # source_suffix = ['.rst', '.md'] -source_suffix = ".rst" +source_suffix = {".rst": "restructuredtext"} # The encoding of source files. # source_encoding = 'utf-8-sig' @@ -67,7 +67,7 @@ # # This is also used if you do content translation via gettext catalogs. # Usually you set "language" from the command line for these cases. -language = None +language = "en" # There are two options for replacing |today|: either, you set today to some # non-false value, then it is used: @@ -140,7 +140,7 @@ # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = ["_static"] +# html_static_path = ["_static"] # Add any extra paths that contain custom files (such as robots.txt or # .htaccess) here, relative to this directory. These files are copied @@ -295,4 +295,4 @@ # Example configuration for intersphinx: refer to the Python standard library. -intersphinx_mapping = {"https://docs.python.org/": None} +intersphinx_mapping = {"python": ("https://docs.python.org/", None)} diff --git a/docs/python_example.rst b/docs/python_example.rst index 2048d23..51e418d 100644 --- a/docs/python_example.rst +++ b/docs/python_example.rst @@ -1 +1,4 @@ +The python_example module +========================= + .. automodule:: python_example