Skip to content

Commit

Permalink
Merge pull request #19 from stephenhky/readthedocs
Browse files Browse the repository at this point in the history
New readthedocs.yaml
  • Loading branch information
stephenhky authored Aug 18, 2023
2 parents 91fdd2a + 485449d commit 5e71aa9
Show file tree
Hide file tree
Showing 9 changed files with 18 additions and 27 deletions.
12 changes: 0 additions & 12 deletions .circleci/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -21,16 +21,6 @@ shared: &shared
jobs:
py36:
<<: *shared
docker:
- image: cimg/python:3.6

py37:
<<: *shared
docker:
- image: cimg/python:3.7

py38:
<<: *shared
docker:
Expand All @@ -56,8 +46,6 @@ workflows:
version: 2
build:
jobs:
- py36
- py37
- py38
- py39
- py310
Expand Down
10 changes: 6 additions & 4 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,11 @@ version: 2
sphinx:
configuration: docs/conf.py

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

# Build documentation with MkDocs
#mkdocs:
# configuration: mkdocs.yml
Expand All @@ -18,8 +23,5 @@ formats: all

# Optionally set the version of Python and requirements required to build your docs
python:
version: 3.8
install:
- requirements: requirements.txt
- method: pip
path: .
- requirements: docs/requirements.txt
8 changes: 3 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,17 +39,14 @@ the codes of TDA separately, and name this package `mogutda`.

## Prerequisite

It runs under Python 3.6, 3.7, 3.8, 3.9, 3.10, and 3.11.

Release 0.1.5 can work under `numpy`>0.16.0, but previous
release will constitute error under the new `numpy`.
It runs under Python 3.8, 3.9, 3.10, and 3.11.

## Simple Tutorial: Simplicial Complex

You can install by:

```
pip install -U mogutda
pip install mogutda
```

To establish a simplicial complex for a torus, type
Expand Down Expand Up @@ -93,6 +90,7 @@ the simplicial complexes are, and how homologies are defined:

## News

* 08/18/2023: `mogutda` 0.4.0 released.
* 06/20/2023: `mogutda` 0.3.5 released.
* 09/09/2022: `mogutda` 0.3.4 released.
* 07/15/2021: `mogutda` 0.3.3 released.
Expand Down
2 changes: 1 addition & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@
# The short X.Y version.
version = u'0.3'
# The full version, including alpha/beta/rc tags.
release = u'0.3.5'
release = u'0.4.0'

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
Expand Down
2 changes: 1 addition & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ draw some insights from them. A lot of machine learning algorithms deal
with distances, which are extremely useful, but they miss the
information the data may carry from their geometry.

`mogutda` runs in Python 3.6, 3.7, 3.8, 3.9, 3.10, and 3.11.
`mogutda` runs in Python 3.8, 3.9, 3.10, and 3.11.

Contributors:

Expand Down
1 change: 1 addition & 0 deletions docs/news.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
News
====

* 08/18/2023: `mogutda` 0.4.0 released.
* 06/20/2023: `mogutda` 0.3.5 released.
* 09/09/2022: `mogutda` 0.3.4 released.
* 07/15/2021: `mogutda` 0.3.3 released.
Expand Down
4 changes: 4 additions & 0 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
numpy==1.23.3
scipy==1.10.0
networkx==3.1
matplotlib==3.3.0
2 changes: 1 addition & 1 deletion requirements.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
numpy>=1.16.0
scipy>=1.2.0
scipy>=1.10.0
networkx>=2.0
matplotlib>=3.3.0
4 changes: 1 addition & 3 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -21,15 +21,13 @@ def install_requirements():


setup(name='mogutda',
version="0.3.5",
version="0.4.0",
description="Topological Data Analysis in Python",
long_description=package_description(),
long_description_content_type='text/markdown',
classifiers=[
"Topic :: Scientific/Engineering :: Mathematics",
"Topic :: Scientific/Engineering :: Physics",
"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",
Expand Down

0 comments on commit 5e71aa9

Please sign in to comment.