Skip to content

Commit

Permalink
Merge pull request #122 from rspencer01/fix_docs
Browse files Browse the repository at this point in the history
[docs, ci]: Fix readthedocs and remove cruft from built distributions
  • Loading branch information
rspencer01 authored Oct 15, 2024
2 parents 4c5bb90 + d8c0fbe commit 60a63a0
Show file tree
Hide file tree
Showing 5 changed files with 13 additions and 7 deletions.
4 changes: 3 additions & 1 deletion .circleci/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -159,8 +159,10 @@ jobs:
else
echo "Not on an exact tag: refusing to publish"
fi
elif [[ $PYPI_INSTANCE == "none" ]]; then
echo "Not uploading"
else
echo "Variable PYPI_INSTANCE must be set to either `live` or `test`."
echo "Variable PYPI_INSTANCE must be set to either \"live\" or \"test\" or \"none\"."
exit 1
fi
workflows:
Expand Down
2 changes: 1 addition & 1 deletion .readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ version: 2
build:
os: ubuntu-20.04
tools:
python: "3.8"
python: "3.11"

# Build documentation in the docs/ directory with Sphinx
sphinx:
Expand Down
9 changes: 6 additions & 3 deletions MANIFEST.in
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
include README.md
include CHANGES.md
include LICENSE
prune .circleci
prune ci
prune docs
prune logo
prune pybloqs/static/uncompressed
prune tests
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

[![CircleCI](https://circleci.com/gh/man-group/PyBloqs.svg?style=shield)](https://circleci.com/gh/man-group/PyBloqs)
[![PyPI](https://img.shields.io/pypi/pyversions/pybloqs.svg)](https://pypi.python.org/pypi/pybloqs/)
[![ReadTheDocs](https://readthedocs.org/projects/pybloqsmain/badge)](https://pybloqsmain.readthedocs.io)
[![ReadTheDocs](https://readthedocs.org/projects/pybloqs/badge)](https://pybloqs.readthedocs.io)
[![Coverage Status](https://coveralls.io/repos/github/manahl/PyBloqs/badge.svg?branch=master)](https://coveralls.io/github/manahl/PyBloqs?branch=master)

PyBloqs is a flexible framework for visualizing data and automated creation of reports.
Expand All @@ -20,7 +20,7 @@ separately for fast development turnover. Lists of blocks can be stacked togethe

### Install PyBloqs

See the [documentation](https://pybloqsmain.readthedocs.io/en/latest/installation.html) for installation instructions.
See the [documentation](https://pybloqs.readthedocs.io/en/latest/installation.html) for installation instructions.

### Using PyBloqs

Expand Down
1 change: 1 addition & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ name = "pybloqs"
requires-python = ">= 3.6"
authors = [{ name = "Man Alpha Technology", email = "[email protected]" }]
keywords = ["ahl", "pdf", "html", "visualization", "report"]
license = { file = "LICENSE" }
classifiers = [
"Operating System :: OS Independent",
"Intended Audience :: Science/Research",
Expand Down

0 comments on commit 60a63a0

Please sign in to comment.