Update docs (#11)

tsutsu3 · Nov 14, 2020 · c9da56c · c9da56c
1 parent 997d51e
commit c9da56c
Show file tree

Hide file tree

Showing 13 changed files with 145 additions and 151 deletions.
diff --git a/.github/workflows/sphinx.yml b/.github/workflows/sphinx.yml
diff --git a/.readthedocs.yml b/.readthedocs.yml
@@ -0,0 +1,29 @@
+# .readthedocs.yml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+  builder: html
+  configuration: conf.py
+  fail_on_warning: true
+
+# Build documentation with MkDocs
+#mkdocs:
+#  configuration: mkdocs.yml
+
+# Optionally build your docs in additional formats such as PDF
+# formats:
+#   - pdf
+
+# Optionally set the version of Python and requirements required to build your docs
+python:
+  version: 3.7
+  install:
+    - method: pip
+      path: .
+      extra_requirements:
+        - doc
diff --git a/docs/conf.py b/docs/conf.py
@@ -35,7 +35,7 @@
     "sphinx.ext.autodoc",
     "sphinx.ext.viewcode",
     "sphinx.ext.napoleon",
-    "sphinx_rtd_theme",
+    "myst_parser",
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -52,8 +52,9 @@
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-# html_theme = "sphinx_book_theme"
-html_theme = "sphinx_rtd_theme"
+html_theme = "sphinx_book_theme"
+
+html_title = "linkify-it-py"
 
 # 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,

diff --git a/docs/index.md b/docs/index.md
@@ -0,0 +1,10 @@
+```{include} ../README.md
+```
+
+```{toctree}
+---
+maxdepth: 2
+caption: Contents
+---
+linkify_it
+```
diff --git a/docs/index.rst b/docs/index.rst
diff --git a/docs/linkify_it.rst b/docs/linkify_it.rst
@@ -12,18 +12,18 @@ linkify\_it.main module
    :undoc-members:
    :show-inheritance:
 
-linkify\_it.re module
----------------------
+linkify\_it.tlds module
+-----------------------
 
-.. automodule:: linkify_it.re
+.. automodule:: linkify_it.tlds
    :members:
    :undoc-members:
    :show-inheritance:
 
-Module contents
----------------
+linkify\_it.ucre module
+-----------------------
 
-.. automodule:: linkify_it
+.. automodule:: linkify_it.ucre
    :members:
    :undoc-members:
    :show-inheritance:
diff --git a/docs/modules.rst b/docs/modules.rst
diff --git a/docs/setup.rst b/docs/setup.rst
diff --git a/docs/test.rst b/docs/test.rst