Skip to content

Commit

Permalink
[0.0.1] Fix documentation and requirements
Browse files Browse the repository at this point in the history
  • Loading branch information
martinferianc committed Feb 12, 2024
1 parent 95f0f52 commit 8f57bfd
Show file tree
Hide file tree
Showing 4 changed files with 44 additions and 15 deletions.
10 changes: 5 additions & 5 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,14 @@
import shutil
import sys

sys.path.insert(0, os.path.abspath("../yamle/"))
sys.path.insert(0, os.path.abspath(".."))

import yamle


def run_apidoc(app):
"""Generate doc stubs using sphinx-apidoc."""
module_dir = os.path.join(app.srcdir, "../yamle/")
module_dir = os.path.join(app.srcdir, "../")
output_dir = os.path.join(app.srcdir, "_apidoc")
excludes = []

Expand Down Expand Up @@ -45,7 +45,7 @@ def setup(app):


# Sphinx configuration below.
project = "YAMLE"
project = "yamle"
version = yamle.__version__
release = yamle.__version__
athor = "Martin Ferianc"
Expand Down Expand Up @@ -91,7 +91,7 @@ def setup(app):
"icon_links": [
{
"name": "GitHub",
"url": "https://github.com/martinferianc/YAMLE",
"url": "https://github.com/martinferianc/yamle",
"icon": "fa-brands fa-square-github",
"type": "fontawesome",
}
Expand All @@ -101,7 +101,7 @@ def setup(app):
}
html_context = {
"github_user": "martinferianc",
"github_repo": "YAMLE",
"github_repo": "yamle",
"github_version": "main",
"doc_path": "docs",
"default_mode": "light",
Expand Down
32 changes: 32 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
[build-system]
requires = ["setuptools", "setuptools-scm"]
build-backend = "setuptools.build_meta"

[project]
name = "yamle"
authors = [{name = "Martin Ferianc", email = "ferianc.martin@gmail.com"}]
description = "YAMLE: Yet Another Machine Learning Environment"
version = "0.0.1"
classifiers = [
"Development Status :: 3 - Alpha",
"Intended Audience :: Developers",
"Intended Audience :: Science/Research",
"Topic :: Scientific/Engineering :: Artificial Intelligence",
"License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)",
"Programming Language :: Python :: 3",
]
license = {file = "LICENSE"}
requires-python = ">=3.9"
dynamic = ["readme", "dependencies"]

[tool.setuptools.packages.find]
where = ["yamle"]

[tool.setuptools.dynamic]
readme = {file = ["README.rst"]}
dependencies = {file = ["requirements.txt"]}

[tool.black]
line-length = 100
target-version = ["py39", "py310"]
include = '\.pyi?$'
6 changes: 2 additions & 4 deletions requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,5 @@ natsort==8.4.0
backpack-for-pytorch==1.6.0
paretoset==1.2.3
natsort==8.4.0
sphinx-hoverxref
sphinxext-opengraph
sphinx-paramlinks
pydata-sphinx-theme
gpytorch==1.11.0
syne-tune[basic]==0.10.0
11 changes: 5 additions & 6 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@ def read(fname):
AUTHOR = "Martin Ferianc"
REQUIRES_PYTHON = ">=3.9.0"
VERSION = "0.0.1"
LICENSE = "MIT"
KEYWORDS = "supervised learning, neural networks, deep learning, machine learning, open-source software"
LICENSE = "GNU GPLv3+"
KEYWORDS = "machine learning, deep learning, python3, open source software"

# What packages are required for this module to be executed?
REQUIRED = [
Expand Down Expand Up @@ -45,10 +45,9 @@ def read(fname):
"backpack-for-pytorch==1.6.0",
"paretoset==1.2.3",
"natsort==8.4.0",
"sphinx-hoverxref",
"sphinxext-opengraph",
"sphinx-paramlinks",
"pydata-sphinx-theme",
"gpytorch==1.11.0",
"syne-tune[basic]==0.10.0"

]
EXTRAS = {}
DEV = []
Expand Down

0 comments on commit 8f57bfd

Please sign in to comment.