Skip to content

Commit

Permalink
Merge pull request #158 from hrcorval/release_4.0.7
Browse files Browse the repository at this point in the history
Updating the documentation to access this one from ReadTheDocs
  • Loading branch information
hrcorval authored Oct 8, 2024
2 parents 7e3a3f7 + 128809a commit ea1d5ce
Show file tree
Hide file tree
Showing 5 changed files with 62 additions and 311 deletions.
18 changes: 18 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
version: 2

sphinx:
configuration: docs/conf.py

formats:
- pdf
- epub

python:
version: "3.8"
install:
- requirements: docs/requirements.txt

build:
os: ubuntu-22.04
tools:
python: "3.8"
304 changes: 0 additions & 304 deletions docs/README.md

This file was deleted.

26 changes: 26 additions & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# Configuration file for the Sphinx documentation builder.

# -- Project information -----------------------------------------------------
project = 'BehaveX'
copyright = '2024, hrcorval'
author = 'hrcorval'

# -- General configuration ---------------------------------------------------
extensions = [
'recommonmark',
'sphinx.ext.autodoc',
'sphinx.ext.viewcode',
]

# The master toctree document.
master_doc = 'index'

# The suffix(es) of source filenames.
source_suffix = ['.rst', '.md']

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']

# -- Options for HTML output -------------------------------------------------
html_theme = 'sphinx_rtd_theme'
15 changes: 15 additions & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
Welcome to BehaveX's documentation!
===================================

.. toctree::
:maxdepth: 2
:caption: Contents:

../README.md

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
10 changes: 3 additions & 7 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,7 +1,3 @@
behave==1.2.6
behavex-images
configobj
csscompressor
htmlmin
jinja2
mkdocs>=1.2.3
recommonmark
sphinx
sphinx_rtd_theme

0 comments on commit ea1d5ce

Please sign in to comment.