Skip to content

Commit

Permalink
Merge pull request #20 from krassowski/fix-docs
Browse files Browse the repository at this point in the history
Add new format RDT config
  • Loading branch information
krassowski committed Oct 12, 2023
2 parents b7d1f12 + 9fdb6a3 commit f5fb55e
Show file tree
Hide file tree
Showing 5 changed files with 26 additions and 11 deletions.
16 changes: 16 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
version: 2

build:
os: ubuntu-22.04
tools:
python: "3.10"

sphinx:
configuration: docs/conf.py

python:
install:
- method: pip
path: .
extra_requirements:
- docs
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Easy-entrez:

- makes common tasks easy thanks to simple Pythonic API,
- is typed and integrates well with mypy,
- is tested on Windows, Mac and Linux across Python 3.7, 3.8, 3.9 and 3.10,
- is tested on Windows, Mac and Linux across Python 3.7, 3.8, 3.9, 3.10 and 3.11
- is limited in scope, allowing to focus on the reliability of the core code,
- does not use the stateful API as it is [error-prone](https://gitlab.com/ncbipy/entrezpy/-/issues/7) as seen on example of the alternative *entrezpy*.

Expand Down
1 change: 0 additions & 1 deletion requirements/dev.txt
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
-r ./minimal.txt
-r ./optional.txt
-r ./docs.txt
pytest
pytest-cov
6 changes: 0 additions & 6 deletions requirements/docs.txt

This file was deleted.

12 changes: 9 additions & 3 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -36,16 +36,22 @@ def get_long_description(file_name):
'Typing :: Typed',
'Intended Audience :: Developers',
'Intended Audience :: Science/Research',
'Programming Language :: Python :: 3.6',
'Programming Language :: Python :: 3.7',
'Programming Language :: Python :: 3.8',
'Programming Language :: Python :: 3.9',
'Programming Language :: Python :: 3.10',
'Programming Language :: Python :: 3.11'
],
install_requires=['requests', 'typing_extensions', 'dataclasses>="0.7";python_version<"3.7"'],
install_requires=['requests', 'typing_extensions'],
extras_require={
'with_progress_bars': ['tqdm'],
'with_parsing_utils': ['pandas']
'with_parsing_utils': ['pandas'],
'docs': [
'sphinx<6.0',
'pydata-sphinx-theme',
'sphinx-autodoc-typehints',
'sphinx-copybutton',
'myst-parser'
]
}
)

0 comments on commit f5fb55e

Please sign in to comment.