aws / sagemaker-experiments

Experiment tracking and metric logging for Amazon SageMaker notebooks and model training.
Apache License 2.0
126 stars 36 forks source link

fix doc generation #153

Closed danabens closed 2 years ago

danabens commented 2 years ago

fix doc generation

failure: https://readthedocs.org/projects/sagemaker-experiments/builds/16012826/

fix: https://stackoverflow.com/questions/66891018/sphinx-what-is-the-cause-for-warning-duplicate-object-description

❯ tox -e docs
GLOB sdist-make: /Users/danabens/workplace/github/aws/sagemaker-experiments/setup.py
docs inst-nodeps: /Users/danabens/workplace/github/aws/sagemaker-experiments/.tox/.tmp/package/1/sagemaker-experiments-0.1.36.dev4+g0396f10.d20220225.zip
docs installed: alabaster==0.7.12,atomicwrites==1.4.0,attrs==21.4.0,Babel==2.9.1,boto3==1.21.7,botocore==1.24.7,certifi==2021.10.8,charset-normalizer==2.0.12,commonmark==0.9.1,coverage==6.3.2,distlib==0.3.4,docker==5.0.3,docutils==0.17.1,execnet==1.9.0,filelock==3.6.0,flake8==4.0.1,idna==3.3,imagesize==1.3.0,importlib-metadata==0.23,Jinja2==3.0.3,jmespath==0.10.0,joblib==1.1.0,MarkupSafe==2.1.0,mccabe==0.6.1,more-itertools==8.12.0,numpy==1.21.5,packaging==21.3,pandas==1.3.5,platformdirs==2.5.1,pluggy==0.13.1,py==1.11.0,pycodestyle==2.8.0,pyflakes==2.4.0,Pygments==2.11.2,pyparsing==3.0.7,pytest==4.4.1,pytest-cov==2.9.0,pytest-cover==3.0.0,pytest-coverage==0.0,pytest-forked==1.4.0,pytest-rerunfailures==8.0,pytest-xdist==1.34.0,python-dateutil==2.8.2,pytz==2021.3,readthedocs-sphinx-ext==2.1.4,recommonmark==0.7.1,requests==2.27.1,s3transfer==0.5.2,sagemaker-experiments @ file:///Users/danabens/workplace/github/aws/sagemaker-experiments/.tox/.tmp/package/1/sagemaker-experiments-0.1.36.dev4%2Bg0396f10.d20220225.zip,scikit-learn==1.0.2,scipy==1.7.3,six==1.16.0,sklearn==0.0,snowballstemmer==2.2.0,Sphinx==4.4.0,sphinx-rtd-theme==1.0.0,sphinxcontrib-applehelp==1.0.2,sphinxcontrib-devhelp==1.0.2,sphinxcontrib-htmlhelp==2.0.0,sphinxcontrib-jsmath==1.0.1,sphinxcontrib-qthelp==1.0.3,sphinxcontrib-serializinghtml==1.1.5,threadpoolctl==3.1.0,toml==0.10.2,tox==3.13.1,typing_extensions==4.1.1,urllib3==1.26.8,virtualenv==20.13.2,websocket-client==1.2.3,zipp==3.7.0
docs run-test-pre: PYTHONHASHSEED='2804274006'
docs run-test: commands[0] | sphinx-build -T -W -b html -d _build/doctrees-readthedocs -D language=en . _build/html
Running Sphinx v4.4.0
loading translations [en]... done
loading intersphinx inventory from http://docs.python.org/objects.inv...
intersphinx inventory has moved: http://docs.python.org/objects.inv -> https://docs.python.org/3/objects.inv
[autosummary] generating autosummary for: experiment.rst, index.rst, links.rst, metrics.rst, tracker.rst, trial.rst, trial_component.rst
building [mo]: targets for 0 po files that are out of date
building [html]: targets for 7 source files that are out of date
updating environment: [new config] 7 added, 0 changed, 0 removed
reading sources... [ 14%] experiment
reading sources... [ 28%] index
reading sources... [ 42%] links
reading sources... [ 57%] metrics
reading sources... [ 71%] tracker
reading sources... [ 85%] trial
reading sources... [100%] trial_component

looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... done
writing output... [ 14%] experiment
writing output... [ 28%] index
writing output... [ 42%] links
writing output... [ 57%] metrics
writing output... [ 71%] tracker
writing output... [ 85%] trial
writing output... [100%] trial_component

generating indices... genindex py-modindex done
writing additional pages... search done
copying static files... done
copying extra files... done
dumping search index in English (code: en)... done
dumping object inventory... done
build succeeded.

The HTML pages are in _build/html.
____________________________________________________________________________ summary ____________________________________________________________________________
  docs: commands succeeded
  congratulations :)