fix: Update Changelog and remove # used for GH issues

CHANGELOG.md

@@ -16,8 +16,8 @@
 
 ### Feat
 
-- #2 Provide option to just create a model for provided book
-- #1 WebUI using Holoviz Panel framework
+- Provide option to just create a model for provided book
+- WebUI using Holoviz Panel framework
 
 ### Refactor
 

README.md

@@ -6,7 +6,7 @@
 
 Converse with a book (PDF)
 
-![](docs/dr-doc-search-github-demo.gif)
+![](assets/dr-doc-search-github-demo.gif)
 
 See [tweet](https://twitter.com/deskriders_twt/status/1612088387984588802) for full demo.
 

docs/api_docs.md

@@ -0,0 +1,3 @@
+# API documentation
+
+:::doc_search

mkdocs.yml

@@ -1,5 +1,5 @@
-site_name: Twitter tools - Collection of twitter utilities.
-repo_url: https://github.com/namuan/twitter-utils
+site_name: Doc Search - Converse with a book (PDF)
+repo_url: https://github.com/namuan/dr-doc-search
 
 theme:
   name: material
@@ -23,3 +23,12 @@ markdown_extensions:
 
 plugins:
   - search:
+  - mkdocstrings:
+      default_handler: python
+      handlers:
+        python:
+          rendering:
+            show_signature_annotations: true
+            show_source: true
+      watch:
+        - src/doc_search

poetry.lock

@@ -624,6 +624,24 @@ files = [
 docs = ["Sphinx", "docutils (<0.18)"]
 test = ["faulthandler", "objgraph", "psutil"]
 
+[[package]]
+name = "griffe"
+version = "0.25.3"
+description = "Signatures for entire Python programs. Extract the structure, the frame, the skeleton of your project, to generate API documentation or find breaking changes in your API."
+category = "dev"
+optional = false
+python-versions = ">=3.7"
+files = [
+    {file = "griffe-0.25.3-py3-none-any.whl", hash = "sha256:c98e8471a4fc7675a7989f45563a9f7ccbfdfb1713725526d69dec1bbdcda74a"},
+    {file = "griffe-0.25.3.tar.gz", hash = "sha256:a71f156851649b3f0bdad6eb6bf7d7ac70e720a30da9f2d5a60e042480e92c03"},
+]
+
+[package.dependencies]
+colorama = ">=0.4"
+
+[package.extras]
+async = ["aiofiles (>=0.7,<1.0)"]
+
 [[package]]
 name = "identify"
 version = "2.5.12"
@@ -939,6 +957,22 @@ crystal = ["mkdocstrings-crystal (>=0.3.4)"]
 python = ["mkdocstrings-python (>=0.5.2)"]
 python-legacy = ["mkdocstrings-python-legacy (>=0.2.1)"]
 
+[[package]]
+name = "mkdocstrings-python"
+version = "0.8.3"
+description = "A Python handler for mkdocstrings."
+category = "dev"
+optional = false
+python-versions = ">=3.7"
+files = [
+    {file = "mkdocstrings-python-0.8.3.tar.gz", hash = "sha256:9ae473f6dc599339b09eee17e4d2b05d6ac0ec29860f3fc9b7512d940fc61adf"},
+    {file = "mkdocstrings_python-0.8.3-py3-none-any.whl", hash = "sha256:4e6e1cd6f37a785de0946ced6eb846eb2f5d891ac1cc2c7b832943d3529087a7"},
+]
+
+[package.dependencies]
+griffe = ">=0.24"
+mkdocstrings = ">=0.19"
+
 [[package]]
 name = "mypy"
 version = "0.991"
@@ -2363,4 +2397,4 @@ testing = ["flake8 (<5)", "func-timeout", "jaraco.functools", "jaraco.itertools"
 [metadata]
 lock-version = "2.0"
 python-versions = ">=3.9.0, <4.0"
-content-hash = "1b4573d056d857cacbbe6ee164af7190b06b11bc2cd794326a54cfbd0f592896"
+content-hash = "98276af914546a90b1ddf76a62d2bb170c9d31135b9d9ef6f855e7029bae1fd7"

pyproject.toml

@@ -65,6 +65,7 @@ commitizen = "^2.20.3"
 pytest = "^7.2.0"
 pytest-cov = "^4.0.0"
 coverage = "^7.0.3"
+mkdocstrings-python = "^0.8.3"
 
 [tool.commitizen]
 name = "cz_conventional_commits"