diff --git a/.github/workflows/ci-pytest.yml b/.github/workflows/ci-pytest.yml index 74e9d62..a310feb 100644 --- a/.github/workflows/ci-pytest.yml +++ b/.github/workflows/ci-pytest.yml @@ -34,7 +34,7 @@ jobs: pip install --upgrade pip - name: Install the package locally - run: pip install -e . + run: pip install -r requirements.txt -r requirements-dev.txt - name: Test with pytest run: | diff --git a/setup.py b/setup.py index c702df6..cb3b6ae 100644 --- a/setup.py +++ b/setup.py @@ -23,9 +23,14 @@ setuptools.setup( "Operating System :: OS Independent", ], package_dir={"": "."}, - packages=["riscemu", "riscemu.decoder", "riscemu.instructions", "riscemu.IO", "riscemu.priv", "riscemu.types"], + packages=[ + "riscemu", + "riscemu.decoder", + "riscemu.instructions", + "riscemu.IO", + "riscemu.priv", + "riscemu.types", + ], python_requires=">=3.6", - install_requires=[ - "pyelftools~=0.27" - ] -) \ No newline at end of file + install_requires=["pyelftools~=0.27"], +) diff --git a/sphinx-docs/source/conf.py b/sphinx-docs/source/conf.py index 37d8b00..4799332 100644 --- a/sphinx-docs/source/conf.py +++ b/sphinx-docs/source/conf.py @@ -18,37 +18,34 @@ import subprocess # import sys # sys.path.insert(0, os.path.abspath('.')) -if os.getenv('READTHEDOCS', False) and not os.path.exists('riscemu.rst'): - subprocess.check_call(['../../generate-docs.sh', 'generate']) +if os.getenv("READTHEDOCS", False) and not os.path.exists("riscemu.rst"): + subprocess.check_call(["../../generate-docs.sh", "generate"]) # -- Project information ----------------------------------------------------- -project = 'RiscEmu' -copyright = '2022, Anton Lydike' -author = 'Anton Lydike' +project = "RiscEmu" +copyright = "2022, Anton Lydike" +author = "Anton Lydike" # The full version, including alpha/beta/rc tags -release = '2.0.0a2' +release = "2.0.0a2" # -- General configuration --------------------------------------------------- # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. -extensions = [ - 'sphinx.ext.autodoc', - 'recommonmark' -] +extensions = ["sphinx.ext.autodoc", "recommonmark"] # autodoc options autodoc_default_options = { - 'members': True, - 'member-order': 'bysource', - 'special-members': '__init__', + "members": True, + "member-order": "bysource", + "special-members": "__init__", } # Add any paths that contain templates here, relative to this directory. -templates_path = ['_templates'] +templates_path = ["_templates"] # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. @@ -58,10 +55,10 @@ templates_path = ['_templates'] from recommonmark.parser import CommonMarkParser # The suffix of source filenames. -source_suffix = ['.rst', '.md'] +source_suffix = [".rst", ".md"] source_parsers = { - '.md': CommonMarkParser, + ".md": CommonMarkParser, } # -- Options for HTML output ------------------------------------------------- @@ -69,18 +66,18 @@ source_parsers = { # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. # -html_theme = 'alabaster' +html_theme = "alabaster" -pygments_style = 'sphinx' +pygments_style = "sphinx" # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = ['_static'] +html_static_path = ["_static"] -sys.path.insert(0, os.path.abspath('../../')) +sys.path.insert(0, os.path.abspath("../../")) -if os.getenv('READTHEDOCS', False): +if os.getenv("READTHEDOCS", False): import sphinx_rtd_theme extensions.append("sphinx_rtd_theme")