Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updating the documentation to access this one from ReadTheDocs #158

Merged
merged 1 commit into from
Oct 8, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
Loading