Skip to content
Permalink
Browse files

docs: update to RTD config ver 2.

  • Loading branch information
blueset committed Jan 12, 2020
1 parent 38b1fdf commit d37aa53ef1a2f13b5c25eb9bd0e564efe0e9305b
Showing with 43 additions and 34 deletions.
  1. +25 −0 .readthedocs.yml
  2. +4 −5 README.rst
  3. +1 −4 docs/conf.py
  4. +0 −17 docs/environment.yml
  5. +5 −5 docs/index.rst
  6. +5 −0 docs/requirements.txt
  7. +3 −3 ehforwarderbot/__main__.py
@@ -0,0 +1,25 @@
# .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:
configuration: docs/conf.py

# Build documentation with MkDocs
#mkdocs:
# configuration: mkdocs.yml

# Optionally build your docs in additional formats such as PDF and ePub
formats: all

# Optionally set the version of Python and requirements required to build your docs
python:
version: 3.7
install:
- requirements: docs/requirements.txt
- method: pip
path: .
@@ -34,10 +34,9 @@ EH Forwarder Bot
:alt: Banner


*Codename* **EH Forwarder Bot** (EFB) is an extensible
chat tunneling framework allowing users to contact
people from multiple chat platforms and remotely
control their accounts in one stop.
*Codename* **EH Forwarder Bot** (EFB) is an extensible message tunneling chat
bot framework which delivers messages to and from multiple platforms and
remotely control your accounts.

For tips, tricks and community contributed articles, see
`project wiki`_.
@@ -87,7 +86,7 @@ License
EFB framework is licensed under `GNU Affero General Public License 3.0`_ or
later versions::

EH Forwarder Bot: An extensible chat tunneling bot framework.
EH Forwarder Bot: An extensible message tunneling chat bot framework.
Copyright (C) 2016 - 2020 Eana Hufwe, and the EH Forwarder Bot contributors
All rights reserved.

@@ -17,12 +17,9 @@
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
#
from __future__ import annotations
import os
import sys

import sphinx_readable_theme

sys.path.insert(0, os.path.abspath('..'))

__version__ = "0.0.0"
@@ -126,7 +123,7 @@
'github_type': 'star',
'github_user': 'blueset',
'github_repo': 'ehforwarderbot',
'description': 'An extensible chat bot tunneling framework.',
'description': 'An extensible message tunneling chat bot framework.',
'donate_url': 'https://github.com/blueset/.github',
'github_banner': "github_banner.svg",
}

This file was deleted.

@@ -1,3 +1,4 @@

EH Forwarder Bot
================

@@ -34,10 +35,9 @@ EH Forwarder Bot
:alt: Banner


*Codename* **EH Forwarder Bot** (EFB) is an extensible
chat tunneling framework allowing users to contact
people from multiple chat platforms and remotely
control their accounts in one stop.
*Codename* **EH Forwarder Bot** (EFB) is an extensible message tunneling chat
bot framework which delivers messages to and from multiple platforms and
remotely control your accounts.


.. toctree::
@@ -90,7 +90,7 @@ or later versions.

.. code-block:: text

EH Forwarder Bot: An extensible chat tunneling bot framework.
EH Forwarder Bot: An extensible message tunneling chat bot framework.
Copyright (C) 2016 - 2020 Eana Hufwe, and the EH Forwarder Bot contributors
All rights reserved.

@@ -0,0 +1,5 @@
pandoc
sphinx
sphinxcontrib-restbuilder
sphinx-autodoc-typehints
sphinx-intl
@@ -32,9 +32,9 @@
if sys.version_info < (3, 6):
raise Exception(_("Python 3.6 or higher is required. Your version is {version}.").format(version=sys.version))

description = _("EH Forwarder Bot is an extensible chat tunnel framework which allows "
"users to contact people from other chat platforms, and ultimately "
"remotely control their accounts in other platforms.")
description = _("EH Forwarder Bot is an extensible message tunneling chat bot "
"framework which delivers messages to and from multiple "
"platforms and remotely control your accounts.")

parser = argparse.ArgumentParser(description=description,
epilog="GitHub: https://efb.1a23.studio")

0 comments on commit d37aa53

Please sign in to comment.
You can’t perform that action at this time.