Meging Docs branch (#70)

* Extending audiobook docs (#67)

* audibook command line bug fixed

* github action bug fixed

* github action bug fixed

* updating docs

* intializing documentation

* basic documentation updated

* updating docs

* Final Fix to sphinx documentation (#69)

* changing directory

* changing directory

* toctree fixed

Co-authored-by: Deepak Raj <[email protected]>

Author: DrakeEntity

.readthedocs.yaml

@@ -11,8 +11,13 @@ build:
   tools:
     python: "3.9"
 
-mkdocs:
-  configuration: mkdocs.yml
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+   configuration: docs/conf.py
+
+# If using Sphinx, optionally build your docs in additional formats such as PDF
+formats:
+   - pdf
 
 # Optionally declare the Python requirements required to build your docs
 python:

CHANGELOG.md

@@ -4,7 +4,12 @@ All notable changes to this project will be documented in this file. The format
 
 ## [Unreleased]
 
-## [V2.0.4] 
+## Proposed Changes/features
+
+- [x] Search book in the library
+- [x] Delete book from the library  
+
+## [V2.0.4]
 
 - [x] Extended pdf_parser to extract table of contents
 - [x] Command line Support added 

README.md

@@ -1,6 +1,6 @@
 <p align="center">
   <a href="https://py-contributors.github.io/audiobook/"><img src="https://capsule-render.vercel.app/api?type=rect&color=009ACD&height=100&section=header&text=audioBook&fontSize=80%&fontColor=ffffff" alt="website title image"></a>
-  <h2 align="center">👉 Listen to any PDF book with a few lines of Python code👈</h2>
+  <h2 align="center">👉 CLI tool to listen to your favourite book in Python 👈</h2>
 </p>
 
 <p align="center">
@@ -24,13 +24,7 @@
 
 Install using [pypi](https://pypi.org/project/audiobook/)
 
-### Linux(setup script)
-
-```sh
-sh setup.sh
-```
-
-### windows and linux
+### Using pip
 
 ```cmd
 pip install audiobook
@@ -44,6 +38,44 @@ Basic usage is exposed via CLI, type `python audiobook -h` for help.
 
 More advanced features are exposed via the API:
 
+```bash
+usage: audiobook [-h] [-p [PATH]] [-l | -c | -s | -r]
+
+AudioBook - listen to any PDF book
+
+optional arguments:
+  -h, --help            show this help message and exit
+  -p [PATH], --path [PATH]
+                        book file path
+  -l, --library         get all books in library
+  -c, --create-json     create json file from input file
+  -s, --save-audio      save audio files from input file
+  -r, --read-book       read the book from input file
+```
+
+#### Example
+
+```bash
+# to read the book
+audiobook -p "C:\Users\user\Documents\book.pdf" -r
+```
+
+```bash
+# to create json file
+audiobook -p "C:\Users\user\Documents\book.pdf" -c
+```
+
+```bash
+# to save audio files
+audiobook -p "C:\Users\user\Documents\book.pdf" -s
+```
+
+```bash
+# to get all books in library
+audiobook -l
+```
+
+
 ```python
 from audiobook import AudioBook
 # argument: Speech-Speed="slow/normal/fast", volume = 0.0 to 1.0

audiobook/__main__.py

@@ -3,10 +3,13 @@
 
 from audiobook.main import AudioBook, BOOK_DIR
 
+__version__ = "2.0.2"
 
 def main():
     parser = argparse.ArgumentParser(description="AudioBook - listen to any PDF book")
     parser.add_argument("-p", "--path", nargs="?", default=None, help="book file path")
+    parser.add_argument('-v', '--version', action='version', version=__version__)
+    parser.add_argument("-l", "--list", action="store_true", help="list all books")
 
     group = parser.add_mutually_exclusive_group()
     group.add_argument(

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/README.md

@@ -0,0 +1,75 @@
+Changelog
+=========
+
+All notable changes to this project will be documented in this file. The
+format is based on `Keep a
+Changelog <https://keepachangelog.com/en/1.0.0/>`__, and this project
+adheres to `Semantic
+Versioning <https://semver.org/spec/v2.0.0.html>`__.
+
+Unreleased
+------------
+
+Proposed Changes/features
+-------------------------
+
+-  ☒ Search book in the library
+-  ☒ Delete book from the library
+
+.. _v204:
+
+V2.0.4
+--------
+
+-  ☒ Extended pdf_parser to extract table of contents
+-  ☒ Command line Support added
+-  ☒ Updated test cases
+-  ☒ Added support for CircleCi CI/CD
+
+.. _v203:
+
+V2.0.3
+--------
+
+-  ☒ Removed from PyPi
+
+.. _v202---22-10-2022:
+
+V2.0.2 - 22-10-2022
+---------------------
+
+-  ☒ Docs files support added
+-  ☒ Pdfminer as engine added
+-  ☒ ODT file support added
+
+.. _v201---17-10-2022:
+
+V2.0.1 - 17-10-2022
+---------------------
+
+-  ☒ Mobi file support
+-  ☒ Epub file support
+-  ☒ User can now save the audiobook for future
+-  ☒ User can now listen to the book from the library
+
+.. _v200---14-10-2022:
+
+V2.0.0 - 14-10-2022
+---------------------
+
+-  ☒ Save Audio Book locally
+-  ☒ Listen to the book
+-  ☒ Speech-speed control
+-  ☒ Read password-protected PDF
+-  ☒ Create JSON file for the book
+
+.. _v105---24-10-2022:
+
+V1.0.5 - 24-10-2020
+---------------------
+
+-  ☒ Deprecated version
+-  ☒ Only can read PDF files
+
+First Release - 22-10-2020
+--------------------------