diff --git a/.bumpversion.cfg b/.bumpversion.cfg index 1abc46f16..72ff5a271 100644 --- a/.bumpversion.cfg +++ b/.bumpversion.cfg @@ -17,5 +17,3 @@ values = [bumpversion:part:devnum] [bumpversion:file:nucypher/__about__.py] - -[bumpversion:file:docs/source/conf.py] diff --git a/.flake8 b/.flake8 index c0c4017cb..699204f2e 100644 --- a/.flake8 +++ b/.flake8 @@ -17,7 +17,6 @@ select = F exclude = .git, __pycache__, - docs/source/conf.py, old, build, dist diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index fb03e12ec..98a9ceaf0 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -35,9 +35,6 @@ repos: - id: debug-statements - id: detect-private-key - # Docs - - id: check-vcs-permalinks - - repo: https://github.com/akaihola/darker rev: 1.6.1 hooks: diff --git a/MANIFEST.in b/MANIFEST.in index ada1d9dd9..826f59baf 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -3,7 +3,6 @@ include LICENSE include README.md include requirements.txt include dev-requirements.txt -include docs-requirements.txt recursive-exclude * __pycache__ global-exclude *.py[cod] diff --git a/Makefile b/Makefile index 95e7e206c..15cd22bba 100644 --- a/Makefile +++ b/Makefile @@ -1,12 +1,8 @@ -.PHONY: clean-pyc clean-build docs +.PHONY: clean-pyc clean-build help: @echo "clean-build - remove build artifacts" @echo "clean-pyc - remove Python file artifacts" - @echo "build-docs - build documentation" - @echo "validate-docs - Validate news fragments" - @echo "docs - build then validate" - @echo "mac-docs - build, validate, the open in default browser (mac only)" @echo "release - package and push a new release" @echo "dist - build wheels and source distribution" @echo "smoke-test - build a source distribution and spawn an active virtual environment" @@ -26,21 +22,6 @@ clean-pyc: find . -name '*.pyo' -exec rm -f {} + find . -name '*~' -exec rm -f {} + -build-docs: - $(MAKE) -C docs clean - $(MAKE) -C docs html - -validate-docs: build-docs - # Requires dependencies from docs-requirements.txt - python3 newsfragments/validate_files.py - python3 -m towncrier --draft - -docs: build-docs validate-docs - readlink -f docs/build/html/index.html - -mac-docs: build-docs validate-docs - open docs/build/html/index.html - release: clean # Enable GPG signing of release commits CURRENT_SIGN_SETTING=$(git config commit.gpgSign) diff --git a/Pipfile b/Pipfile index e77f6885e..de6ab4e49 100644 --- a/Pipfile +++ b/Pipfile @@ -37,7 +37,7 @@ click = ">=7.0" colorama = "*" tabulate = "*" # Template -jinja2 = "<3.1.0" # because of docs +jinja2 = "" # because of docs # Tools eth-account = ">=0.8.0,<0.9" # because of eth-ape (eip712 dep) diff --git a/README.md b/README.md index 653b440fe..0c3fe1f11 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,6 @@ [![pyversions](https://img.shields.io/pypi/pyversions/nucypher.svg)](https://pypi.org/project/nucypher/) [![codecov](https://codecov.io/gh/nucypher/nucypher/branch/development/graph/badge.svg?token=9w1dAFqog5)](https://codecov.io/gh/nucypher/nucypher) [![discord](https://img.shields.io/discord/411401661714792449.svg?logo=discord)](https://discord.gg/7rmXa3S) -[![Documentation Status](https://readthedocs.org/projects/nucypher/badge/?version=latest)](https://nucypher.readthedocs.io/en/latest/) [![license](https://img.shields.io/pypi/l/nucypher.svg)](https://www.gnu.org/licenses/gpl-3.0.html) ---- diff --git a/SECURITY.md b/SECURITY.md index 5f4093c3e..2258b6b9b 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -13,6 +13,6 @@ We are happy to work together to use a more secure medium, such as Signal. Email security@nucypher.com and we will coordinate a communication channel that we're both comfortable with. A great place to begin your research is by working on our testnet. -Please see our [documentation](https://docs.nucypher.com) to get started. +Please see our [documentation](https://docs.threshold.network) to get started. We ask that you please respect network machines and their owners. If you find a vulnerability that you suspect has given you access to a machine against the owner's permission, stop what you're doing and immediately email security@nucypher.com. diff --git a/docs-requirements.txt b/docs-requirements.txt deleted file mode 100644 index 7d5154fc1..000000000 --- a/docs-requirements.txt +++ /dev/null @@ -1,33 +0,0 @@ --i https://pypi.python.org/simple -alabaster==0.7.13 ; python_version >= '3.6' -babel==2.12.1 ; python_version >= '3.7' -certifi==2023.7.22 ; python_version >= '3.6' -charset-normalizer==2.1.1 -click==8.1.7 ; python_version >= '3.7' -click-default-group==1.2.4 ; python_version >= '2.7' -docutils==0.17.1 -idna==3.4 ; python_version >= '3.5' -imagesize==1.4.1 ; python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3' -importlib-resources==6.0.1 ; python_version < '3.10' -incremental==22.10.0 -jinja2==3.0.3 -markupsafe==2.1.3 ; python_version >= '3.7' -packaging==23.1 ; python_version >= '3.7' -pygments==2.16.1 ; python_version >= '3.7' -pytz==2023.3 ; python_version < '3.9' -requests==2.31.0 ; python_version >= '3.7' -setuptools==68.1.2 ; python_version >= '3.8' -snowballstemmer==2.2.0 -sphinx==3.0.1 -sphinx-rtd-theme==1.3.0 -sphinxcontrib-applehelp==1.0.4 ; python_version >= '3.8' -sphinxcontrib-devhelp==1.0.2 ; python_version >= '3.5' -sphinxcontrib-htmlhelp==2.0.1 ; python_version >= '3.8' -sphinxcontrib-jquery==4.1 ; python_version >= '2.7' -sphinxcontrib-jsmath==1.0.1 ; python_version >= '3.5' -sphinxcontrib-qthelp==1.0.3 ; python_version >= '3.5' -sphinxcontrib-serializinghtml==1.1.5 ; python_version >= '3.5' -tomli==2.0.1 ; python_version < '3.11' -towncrier==23.6.0 -urllib3==2.0.4 ; python_version >= '3.7' -zipp==3.16.2 ; python_version < '3.10' diff --git a/nucypher/exceptions.py b/nucypher/exceptions.py index b3437800e..f3487b94a 100644 --- a/nucypher/exceptions.py +++ b/nucypher/exceptions.py @@ -1,6 +1,3 @@ - - - # Package Warnings # #################### @@ -8,9 +5,7 @@ class DevelopmentInstallationRequired(RuntimeError): MESSAGE = ''' - A development installation of nucypher is required to import {importable_name}. - Please follow the installation instructions published at: - https://docs.nucypher.com/en/latest/installation.html + A development installation of nucypher is required to import {importable_name}. ''' def __init__(self, importable_name: str, *args, **kwargs): diff --git a/readthedocs.yml b/readthedocs.yml deleted file mode 100644 index 3930b4967..000000000 --- a/readthedocs.yml +++ /dev/null @@ -1,23 +0,0 @@ -# Read the Docs configuration file -# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details - -# Required -version: 2 - -# Build documentation in the docs/ directory with Sphinx -sphinx: - configuration: docs/source/conf.py - -# Set the version of Python and other tools you might need -build: - os: ubuntu-22.04 - tools: - python: "3.10" - -# Optionally build your docs in additional formats such as PDF and ePub -formats: all - -# Optionally set the requirements required to build your docs -python: - install: - - requirements: docs-requirements.txt diff --git a/scripts/dependencies/docs/Pipfile b/scripts/dependencies/docs/Pipfile deleted file mode 100644 index 26907f203..000000000 --- a/scripts/dependencies/docs/Pipfile +++ /dev/null @@ -1,15 +0,0 @@ -[[source]] -url = "https://pypi.python.org/simple" -verify_ssl = true -name = "pypi" - -[requires] -python_version = "3" - -[packages] -sphinx = "==3.0.1" -docutils = "<0.18.0" -sphinx_rtd_theme = "*" -towncrier = "*" -jinja2 = "<3.1.0" -charset-normalizer= "==2.1.1" diff --git a/scripts/dependencies/relock_dependencies.sh b/scripts/dependencies/relock_dependencies.sh index f477b0954..0913c114a 100755 --- a/scripts/dependencies/relock_dependencies.sh +++ b/scripts/dependencies/relock_dependencies.sh @@ -33,14 +33,6 @@ pip cache purge # start enforcing failures set -e -echo "Building Documentation Requirements" -pushd ./scripts/dependencies/docs -pipenv --python 3.11 lock --clear --pre -pipenv requirements > ../../../docs-$PREFIX.txt -rm -f Pipfile.lock -pipenv --rm -popd - echo "Building Development Requirements" pipenv --python 3.11 lock --clear --pre --dev-only pipenv requirements --dev-only > dev-$PREFIX.txt diff --git a/setup.py b/setup.py index d543428d0..2b7488d67 100644 --- a/setup.py +++ b/setup.py @@ -119,7 +119,6 @@ def read_requirements(path): INSTALL_REQUIRES = read_requirements("requirements.txt") DEV_REQUIRES = read_requirements("dev-requirements.txt") -DOC_REQUIRES = read_requirements("docs-requirements.txt") BENCHMARK_REQUIRES = [ 'pytest-benchmark' @@ -141,7 +140,6 @@ EXTRAS = { "benchmark": DEV_REQUIRES + BENCHMARK_REQUIRES, "deploy": DEPLOY_REQUIRES, "ursula": URSULA_REQUIRES, - "docs": DOC_REQUIRES, } setup(