removed broken scrapers and added basic README

docs/edit_apidoc.sh

@@ -5,7 +5,7 @@ HIDE_COOKIESTRING="   :exclude-members: cookiestring"
 REPLACE_MAXDEPTH="s/   :maxdepth: 4/   :maxdepth: 1/g"
 
 # Remove display of ``cookiestring`` class variable, otherwise Sphinx generates docs containing the value of your cookiestring, based on your ``YOUTUBE_COOKIESTRING`` environment variable
-for file in cisticola.scraper.base.rst cisticola.scraper.rumble.rst cisticola.scraper.youtube.rst
+for file in cisticola.scraper.base.rst cisticola.scraper.rumble.rst
 do
     echo "$HIDE_COOKIESTRING" >> $RST_SOURCE_DIR/$file;
 done

docs/source/cisticola.scraper.gab.rst

@@ -1,7 +0,0 @@
-cisticola.scraper.gab module
-============================
-
-.. automodule:: cisticola.scraper.gab
-   :members:
-   :undoc-members:
-   :show-inheritance:

docs/source/cisticola.scraper.instagram.rst

@@ -1,7 +0,0 @@
-cisticola.scraper.instagram module
-==================================
-
-.. automodule:: cisticola.scraper.instagram
-   :members:
-   :undoc-members:
-   :show-inheritance:

docs/source/cisticola.scraper.odysee.rst

@@ -1,7 +0,0 @@
-cisticola.scraper.odysee module
-===============================
-
-.. automodule:: cisticola.scraper.odysee
-   :members:
-   :undoc-members:
-   :show-inheritance:

docs/source/cisticola.scraper.rst

@@ -14,12 +14,6 @@ Submodules
 
    cisticola.scraper.base
    cisticola.scraper.bitchute
-   cisticola.scraper.gab
    cisticola.scraper.gettr
-   cisticola.scraper.instagram
-   cisticola.scraper.odysee
    cisticola.scraper.rumble
    cisticola.scraper.telegram_telethon
-   cisticola.scraper.twitter
-   cisticola.scraper.vkontakte
-   cisticola.scraper.youtube

docs/source/cisticola.scraper.twitter.rst

@@ -1,7 +0,0 @@
-cisticola.scraper.twitter module
-================================
-
-.. automodule:: cisticola.scraper.twitter
-   :members:
-   :undoc-members:
-   :show-inheritance:

docs/source/cisticola.scraper.vkontakte.rst

@@ -1,7 +0,0 @@
-cisticola.scraper.vkontakte module
-==================================
-
-.. automodule:: cisticola.scraper.vkontakte
-   :members:
-   :undoc-members:
-   :show-inheritance:

docs/source/cisticola.scraper.youtube.rst

@@ -1,8 +0,0 @@
-cisticola.scraper.youtube module
-================================
-
-.. automodule:: cisticola.scraper.youtube
-   :members:
-   :undoc-members:
-   :show-inheritance:
-   :exclude-members: cookiestring

docs/source/cisticola.transformer.rst

@@ -17,5 +17,3 @@ Submodules
    cisticola.transformer.gettr
    cisticola.transformer.rumble
    cisticola.transformer.telegram_telethon
-   cisticola.transformer.twitter
-   cisticola.transformer.vkontakte

docs/source/cisticola.transformer.twitter.rst

@@ -1,7 +0,0 @@
-cisticola.transformer.twitter module
-====================================
-
-.. automodule:: cisticola.transformer.twitter
-   :members:
-   :undoc-members:
-   :show-inheritance:

docs/source/cisticola.transformer.vkontakte.rst

@@ -1,7 +0,0 @@
-cisticola.transformer.vkontakte module
-======================================
-
-.. automodule:: cisticola.transformer.vkontakte
-   :members:
-   :undoc-members:
-   :show-inheritance:

docs/source/quickstart.rst

@@ -34,7 +34,7 @@ If you do not already have a Telegram application, you can create one by followi
 
 To initialize a Telegram session, run the following script from the package's root directory using the command-line:
 
-.. bash::
+.. code-block:: console
 
     bash telethon_session_init.py
 
@@ -43,13 +43,13 @@ Documentation
 
 The *cisticola* application uses Sphinx_ to generate and display its documentation. To build the documentation in the HTML format, run the following command from the ``docs/`` directory:
 
-.. code-block::
+.. code-block:: console
 
     pipenv run make html
 
 For developers, if changes are made to the package structure or additional modules are created, you can update the Sphinx source ``*.rst`` files by running the following command from the ``docs/`` directory:
 
-.. code-block::
+.. code-block:: console
 
     pipenv run make apidoc