From f411f8083737c681fcfde836a82255f111ce9228 Mon Sep 17 00:00:00 2001 From: Nicholas Long <1907354+nllong@users.noreply.github.com> Date: Tue, 16 Jan 2024 14:14:10 -0700 Subject: [PATCH] Update developer documentation dependencies (#4485) update sphinx version and related files --- .cspell.json | 440 ++++++++++++++++++++++++++ .gitignore | 8 +- bin/protractor_start_server.sh | 4 +- docs/source/conf.py | 6 +- docs/source/docker.rst | 2 +- docs/source/kubernetes_deployment.rst | 8 +- docs/source/migrations.rst | 4 +- docs/source/modules/seed.rst | 8 - docs/source/modules/seed.utils.rst | 16 - requirements/test.txt | 25 +- tox.ini | 3 +- 11 files changed, 469 insertions(+), 55 deletions(-) create mode 100644 .cspell.json diff --git a/.cspell.json b/.cspell.json new file mode 100644 index 0000000000..f74492eb55 --- /dev/null +++ b/.cspell.json @@ -0,0 +1,440 @@ +{ + "version": "0.2", + "language": "en", + "words": [ + "accessor", + "Accessor", + "ActionChains", + "admin", + "afterwards", + "ajax", + "Aleck", + "Amongst", + "analysispropertyview", + "Andriy", + "angularjs", + "api", + "API", + "app", + "approver", + "args", + "Args", + "assertDictContainsSubset", + "attr", + "attrs", + "auditlog", + "auth", + "autogenerated", + "automodule", + "aws", + "AWS", + "backend", + "backends", + "badpass", + "Baseload", + "basestring", + "bashrc", + "bedes", + "BEPS", + "biffh", + "Bool", + "boolean", + "bricr", + "BrowserDefinition", + "bsync", + "bsyncr", + "Btus", + "buildingsnapshot", + "BuildingSnapshot", + "BuildingSnapshots", + "buildingsync", + "bytestring", + "calendarize", + "canonicalbuilding", + "CanonicalBuilding", + "casted", + "cb", + "CEJST", + "celerybeat", + "cfg", + "changelog", + "checkbox", + "checkboxes", + "chomsky", + "Chomsky", + "chunked", + "ci", + "cli", + "cmp", + "codebase", + "collectstatic", + "columnlistprofile", + "columnmapping", + "columnmappingprofile", + "comparators", + "concat", + "cond", + "condas", + "config", + "contrib", + "coparent", + "coparents", + "createdb", + "createuser", + "crlf", + "csrfmiddlewaretoken", + "css", + "csv", + "csvfile", + "csvreader", + "Ctrl", + "customizable", + "datacoercions", + "dataset", + "datasets", + "datasource", + "datasources", + "datatypes", + "datestrings", + "datetime", + "dateutil", + "dedeploy", + "defaultdb", + "defaultdict", + "dest", + "dev", + "dict", + "dicts", + "diffupdate", + "disableable", + "django", + "Django", + "docker0", + "docstring", + "docstrings", + "Drozdyuk", + "edgecase", + "eeej", + "ejscreen", + "energystar", + "enums", + "env", + "ESPM", + "eui", + "eula", + "fieldname", + "fieldnames", + "FileField", + "filename", + "filepath", + "filesystem", + "fineuploader", + "firefox", + "Firefox", + "fn", + "frontend", + "func", + "FunctionalLiveServerBaseTestCase", + "gcc", + "geocode", + "geocoded", + "geocoding", + "geocodings", + "geomodels", + "getattr", + "getenv", + "getitem", + "gis", + "Github", + "Google", + "graphviz", + "greenbutton", + "gte", + "Gunter", + "Gzip", + "hardcoded", + "hardcoding", + "Homebrew", + "hotfix", + "hpxml", + "href", + "html", + "iand", + "idx", + "importfile", + "ImportFile", + "Indices", + "init", + "initdb", + "initializer", + "io", + "ior", + "ip", + "iterable", + "Iterable", + "iteritems", + "jaccard", + "js", + "JSESSIONID", + "jshint", + "json", + "JsonField", + "JSONField", + "kBtu", + "klass", + "kubeconfig", + "kubectl", + "Kubectl", + "Kubernetes", + "kwargs", + "Landgraf", + "len", + "libpq", + "Linux", + "localhost", + "locator", + "Locator", + "loggedInFunctionalTestCaseFactory", + "LoggedInTests", + "loggedout", + "loggedOutFunctionalTestCaseFactory", + "LoggedOutTests", + "login", + "Login", + "lokalise", + "lokalize", + "lookup", + "lte", + "lxml", + "MapItem", + "mappable", + "mapquest", + "maxdepth", + "mcm", + "metadata", + "meterdata", + "meterreading", + "middleware", + "MIDDLEWARE", + "mixin", + "mmbtu", + "ModelSerializer", + "multipart", + "Multipart", + "Munday", + "MyBrowser", + "MyModel", + "namespace", + "natively", + "netcat", + "newdomain", + "nginx", + "nlong", + "NOAA", + "nodejs", + "noncanonicalprojectbuildings", + "nondefault", + "nones", + "noqa", + "npm", + "nrows", + "nsmap", + "num", + "Octant", + "officedocument", + "onload", + "openxmlformats", + "OperationalError", + "OrderedDict", + "OrderedDicts", + "org", + "orgfilter", + "orgs", + "os", + "OSX", + "param", + "params", + "paramType", + "persistentvolumes", + "pgdata", + "pk", + "pks", + "polyfill", + "postactivate", + "postfix", + "postgis", + "postgres", + "postgresql", + "PostgreSQL", + "postoffice", + "pre", + "Pre", + "precommit", + "pregeocoded", + "prepend", + "PrimaryKeyRelatedField", + "projectbuilding", + "propertystate", + "propertyview", + "prprty", + "psql", + "pvwatts", + "py", + "pyenv", + "Pyright", + "pytype", + "pytz", + "qqfile", + "qs", + "quantityfield", + "queryset", + "querysets", + "quickstart", + "readthedocs", + "RECAPTCHA", + "Recurse", + "redis", + "Redis", + "rediss", + "Redistributions", + "regex", + "repo", + "rgetattr", + "rmi", + "rtype", + "runserver", + "runTest", + "runtime", + "salesforce", + "scalable", + "seeddb", + "seedorg", + "seedpass", + "seedplatform", + "seeduser", + "selfvars", + "sendmail", + "serializable", + "serializer", + "serializers", + "servlet", + "Setpoints", + "setUp", + "setUpClass", + "sha", + "signup", + "spreadsheetml", + "springframework", + "sqft", + "Starke", + "STATICFILES", + "statuslabel", + "str", + "strcmp", + "strftime", + "subclasses", + "subdirectory", + "Submodules", + "submonthly", + "suborg", + "Subpackages", + "subtask", + "sudo", + "superperms", + "superset", + "TableRows", + "tastypie", + "taxlot", + "TaxLot", + "taxlots", + "TaxLots", + "taxlotstate", + "taxlotview", + "taxview", + "td", + "tearDown", + "templatetags", + "TestCaseFactory", + "TestCaseFactoryBrowser", + "Thusly", + "timescaledb", + "timeseries", + "timestamp", + "timestamps", + "timezones", + "toctree", + "todo", + "Todo", + "TODO", + "ToS", + "travis", + "tsts", + "tuples", + "typechecking", + "ubid", + "UBID", + "ubidmodel", + "ubids", + "Ubuntu", + "UI", + "Uncomment", + "ungeocoded", + "unicode", + "uniformat", + "unittest", + "unlinkable", + "unmatch", + "unmatching", + "unmerge", + "unmerges", + "unpair", + "unresolvable", + "untracked", + "uom", + "uploader", + "uploaderfunc", + "upserts", + "ureg", + "uri", + "url", + "urllist", + "urls", + "URLs", + "username", + "usr", + "util", + "utils", + "uwsgi", + "uWSGI", + "validator", + "validators", + "vcr", + "viewsets", + "virtualenv", + "virtualenvs", + "virtualenvwrapper", + "webdriver", + "webserver", + "webservers", + "whitelist", + "wildcards", + "workflow", + "workon", + "wsgi", + "xlarge", + "xlrd", + "xlsxwriter", + "xml", + "xmltodict", + "xpath", + "XPath", + "XPATH", + "xpaths", + "XSLX", + "yasg", + "yml" + ], + "flagWords": [ + "hte" + ] +} diff --git a/.gitignore b/.gitignore index 6c49aab7ea..a91e7ee8a6 100644 --- a/.gitignore +++ b/.gitignore @@ -1,17 +1,18 @@ -.DS_Store .cache +.coverage +.cspell.txt +.DS_Store .env .hypothesis .idea .project .pydevproject .python-version -.coverage .vscode coverage.protractor.json -.vscode *~ *~$* +*.ipynb *.pyc *.swp *.swo @@ -25,7 +26,6 @@ pkgs/newrelic-1\.6\.0\.13\.tar\.gz chromedriver.log ipython_input_log_history .ipython_input_log_history -*.ipynb **/ipython_input_log_history web_root/csvs/* web_root/uploads/* diff --git a/bin/protractor_start_server.sh b/bin/protractor_start_server.sh index c576cb64d4..3c25e1fb7e 100755 --- a/bin/protractor_start_server.sh +++ b/bin/protractor_start_server.sh @@ -18,8 +18,6 @@ echo "run e2e tests" ./node_modules/protractor/bin/protractor seed/static/seed/tests/protractor-tests/protractorConfigCoverage.js # echo "install coverall merge stuffs" # gem install coveralls-lcov -# pip install coveralls-merge # echo "run lcov to coveralls json" # coveralls-lcov -v -n protractorReports/lcov.info > coverage.protractor.json -# echo "merge and post coveralls" -# coveralls-merge coverage.protractor.json +# echo "upload to coveralls" diff --git a/docs/source/conf.py b/docs/source/conf.py index e06505cf7e..8a173cc41c 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -56,7 +56,9 @@ templates_path = ['_templates'] # Location of word list. -spelling_word_list_filename = '../../.cspell/custom-dictionary-workspace.txt' +# convert the spelling list to a text file and save +open('../../.cspell.txt', 'w').write('\n'.join(json.load(open('../../.cspell.json'))['words'])) +spelling_word_list_filename = '../../.cspell.txt' # The suffix(es) of source filenames. # You can specify multiple suffix as a list of string: @@ -91,7 +93,7 @@ # # This is also used if you do content translation via gettext catalogs. # Usually you set "language" from the command line for these cases. -language = None +language = 'en' # There are two options for replacing |today|: either, you set today to some # non-false value, then it is used: diff --git a/docs/source/docker.rst b/docs/source/docker.rst index 60db652e50..a0208c345b 100644 --- a/docs/source/docker.rst +++ b/docs/source/docker.rst @@ -110,7 +110,7 @@ Ubuntu server 18.04 or newer with a m5ad.xlarge (if using in Production instance Deploying with Docker -^^^^^^^^^^^^^^^^^^ +^^^^^^^^^^^^^^^^^^^^^ The preferred way to deploy with Docker is using docker swarm and docker stack. Look at the `deploy.sh script`_ for implementation details. diff --git a/docs/source/kubernetes_deployment.rst b/docs/source/kubernetes_deployment.rst index 1957c0775c..d0c72cb183 100644 --- a/docs/source/kubernetes_deployment.rst +++ b/docs/source/kubernetes_deployment.rst @@ -59,14 +59,14 @@ Helm Helm organizes all of your Kubernetes deployment, service, and volume yml files into "charts" that can be deployed, managed, and published with simple commands. To install Helm: -* `Windows eksctl https://kubernetes.io/docs/tasks/tools/install-kubectl/#install-kubectl-on-windows`_ +* `Windows eksctl `_ * Mac (with Homebrew) :code:`brew install helm` EKS Control (AWS Specific) ^^^^^^^^^^^^^^^^^^^^^^^^^^ EKSCtl is a command line tool to manage Elastic Kubernetes clusters on AWS. If not using AWS, then disregard this section. -* `Windows `_ +* `Windows eksctl config `_ * Mac (with Homebrew) :code:`brew install eksctl` To launch a cluster on using EKSCts, run the following command in the terminal (assuming adequate permissions for the user). Also make sure to replace items in the `<>` brackets. @@ -164,7 +164,7 @@ This chart contains the deployment specification for the Celery container to con value: # must match db-postgres-deployment.yaml and web-celery-deployment.yaml bsyncr-deployment.yaml -************************** +********************** This chart contains the deployment specification for the bsyncr analysis server. Request a NOAA token from `this website `_. .. code-block:: yaml @@ -242,7 +242,7 @@ The command below will restart the pods and re-pull the docker images. Other Resources --------------- -Common kubectl actions can be found `here `_ +Common kubectl actions can be found `on the kubernetes website `_ .. _AWS: https://docs.aws.amazon.com/eks/latest/userguide/create-cluster.html diff --git a/docs/source/migrations.rst b/docs/source/migrations.rst index e0dce47e67..eb33534532 100644 --- a/docs/source/migrations.rst +++ b/docs/source/migrations.rst @@ -198,9 +198,7 @@ Max OSX Version 2.5.2 ------------- -- There are no manual migrations that are needed. The `./manage.py migrate` command may take awhile -to run since the migration requires the recalculation of all the normalized addresses to parse -bldg correct and to cast the result as a string and not a bytestring. +- There are no manual migrations that are needed. The `./manage.py migrate` command may take awhile to run since the migration requires the recalculation of all the normalized addresses to parse bldg correct and to cast the result as a string and not a bytestring. Version 2.5.1 ------------- diff --git a/docs/source/modules/seed.rst b/docs/source/modules/seed.rst index a8c3166a76..771c0324c2 100644 --- a/docs/source/modules/seed.rst +++ b/docs/source/modules/seed.rst @@ -80,14 +80,6 @@ Token Generator :undoc-members: :show-inheritance: -URLs ----- - -.. automodule:: seed.urls - :members: - :undoc-members: - :show-inheritance: - Utils ----- diff --git a/docs/source/modules/seed.utils.rst b/docs/source/modules/seed.utils.rst index 813f849f94..27fd9b6cf7 100644 --- a/docs/source/modules/seed.utils.rst +++ b/docs/source/modules/seed.utils.rst @@ -20,22 +20,6 @@ Buildings :undoc-members: :show-inheritance: -Constants ---------- - -.. automodule:: seed.utils.constants - :members: - :undoc-members: - :show-inheritance: - -Mappings --------- - -.. automodule:: seed.utils.mapping - :members: - :undoc-members: - :show-inheritance: - Organizations ------------- diff --git a/requirements/test.txt b/requirements/test.txt index 427cb556d3..7808659ee7 100644 --- a/requirements/test.txt +++ b/requirements/test.txt @@ -11,29 +11,28 @@ psutil==5.6.7 # python testing Faker==0.9.3 mock==2.0.0 -coveralls-merge==0.0.3 vcrpy==4.2.1 -pytest==7.2.0 -pytest-django==4.5.2 +pytest==7.4.4 +pytest-django==4.7.0 # Lock urllib3 to v1 until vcrpy supports it urllib3<2 # static code analysis -flake8==3.8.1 -pycodestyle==2.6.0 -pre-commit==2.19.0 +flake8==7.0.0 +pycodestyle==2.11.1 +pre-commit==3.6.0 # documentation and spelling -Sphinx==4.0.2 -sphinxcontrib-spelling==4.3.0 -sphinx_rtd_theme==0.4.3 -docutils==0.17.1 +Sphinx==7.2.6 +sphinxcontrib-spelling==8.0.0 +sphinx_rtd_theme==2.0.0 +docutils==0.20.1 # property-based testing -hypothesis==6.12.0 +hypothesis==6.94.0 # For running the server -uWSGI==2.0.18 +uWSGI==2.0.23; sys_platform != "win32" # static type checking -mypy==1.0.0 +mypy==1.8.0 diff --git a/tox.ini b/tox.ini index 2628465f83..ba221a1658 100644 --- a/tox.ini +++ b/tox.ini @@ -44,6 +44,8 @@ changedir=docs deps= -r{toxinidir}/requirements/test.txt commands= + # After we fix doc build links/issues, then add the -W flag + ; make spelling SPHINXOPTS='-W --keep-going' make spelling sphinx-build -b html -d {envtmpdir}/doctrees {toxinidir}/docs/source {envtmpdir}/html whitelist_externals= @@ -76,7 +78,6 @@ passenv= TRAVIS_BUILD_NUMBER MAPQUEST_API_KEY whitelist_externals= - ; coveralls-merge cp npm