radical-cybertools / radical.entk

The RADICAL Ensemble Toolkit
https://radical-cybertools.github.io/entk/index.html
Other
28 stars 17 forks source link

Broken link in documentation #437

Closed Abdullah-Ghani closed 4 years ago

Abdullah-Ghani commented 4 years ago

RP can be extended to support more HPC systems by contacting the developers of RP/EnTK or by the user themselves by following this page. https://radicalpilot.readthedocs.io/en/latest/machconf.html#writing-a-custom-resource-configuration-file

Quoted from the documentation(https://radicalentk.readthedocs.io/en/latest/introduction.html) 1.1.2. Dependencies. The link seems to be broken

lee212 commented 4 years ago

Thanks for reporting this! I will get this corrected along with other possible broken links.

TODO: Sphinx builder checklink

Abdullah-Ghani commented 4 years ago

Ensemble Toolkit uses RADICAL Pilot (RP) as the runtime system. RP is targeted currently only for a set of high performance computing (HPC) systems (see here-->http://radicalpilot.readthedocs.io/en/latest/resources.html#chapter-resources)

This link seems to be broken as well.

lee212 commented 4 years ago

fix/docs branch will have correct links.

In detail, the broken links were caused by missing latest version from RP. It had to be replaced with stable instead. Sphinx linkcheck detects broken links and the result with the new branch:

(entk.py36) $ make linkcheck
Running Sphinx v2.3.1
loading pickled environment... done
building [mo]: targets for 0 po files that are out of date
building [linkcheck]: targets for 38 source files that are out of date
updating environment: 0 added, 3 changed, 0 removed
reading sources... [100%] user_guide/profiling
WARNING: autodoc: failed to import module 'test_rmgr' from module 'tests.test_component'; the following exception was raised:
No module named 'tests.test_component.test_rmgr'
WARNING: autodoc: failed to import module 'test_tmgr_rp_utils' from module 'tests.test_component'; the following exception was raised:
No module named 'tests.test_component.test_tmgr_rp_utils'
WARNING: autodoc: failed to import module 'test_issue_239' from module 'tests.test_issues'; the following exception was raised:
No module named 'tests.test_issues.test_issue_239'
WARNING: autodoc: failed to import module 'test_init_transition' from module 'tests.test_utils'; the following exception was raised:
No module named 'tests.test_utils.test_init_transition'
WARNING: missing attribute mentioned in :members: or __all__: module tests.test_utils.test_prof_utils, attribute test_write_workflow
/home/hrlee/git/radical.entk/docs/user_guide/profiling.rst:18: WARNING: download file not readable: /home/hrlee/git/radical.entk/examples/analytics/re.session.two.vivek.017759.0012.tar
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... done
writing output... [  2%] adv_examples/adapt_ta
writing output... [  5%] adv_examples/adapt_tc
writing output... [  7%] adv_examples/adapt_to
writing output... [ 10%] advanced_examples
writing output... [ 13%] api
writing output... [ 15%] api/app_create
writing output... [ 18%] api/app_create/pipeline
writing output... [ 21%] api/app_create/stage
writing output... [ 23%] api/app_create/task
writing output... [ 26%] api/appman
writing output... [ 28%] dev_docs
writing output... [ 31%] dev_docs/dev_api
writing output... [ 34%] dev_docs/dev_api/app_manager
writing output... [ 36%] dev_docs/dev_api/pipeline
writing output... [ 39%] dev_docs/dev_api/resource_manager
writing output... [ 42%] dev_docs/dev_api/stage
writing output... [ 44%] dev_docs/dev_api/task
writing output... [ 47%] dev_docs/dev_api/task_manager
writing output... [ 50%] dev_docs/dev_api/wfprocessor
writing output... [ 52%] dev_docs/uml
(line   14) -local-   ../figures/entk_class_diagram.jpg
(line   26) -local-   ../figures/entk_sequence_diagram.jpg
(line   38) -local-   ../figures/entk_state_diagram.png
writing output... [ 55%] entk
(line  155) redirect  https://arxiv.org/pdf/1710.08491 - with Found to https://arxiv.org/pdf/1710.08491.pdf
writing output... [ 57%] examples
writing output... [ 60%] examples/eop
writing output... [ 63%] examples/poe
writing output... [ 65%] exceptions
writing output... [ 68%] index
(line    9) ok        http://radical.rutgers.edu/
(line   17) ok        https://arxiv.org/abs/1710.08491
(line   19) ok        https://arxiv.org/abs/1602.00678v2
(line    9) redirect  http://opensource.org/licenses/MIT - permanently to https://opensource.org/licenses/MIT
(line   30) ok        https://github.com/radical-cybertools/radical.entk
(line   34) redirect  https://groups.google.com/d/forum/ensemble-toolkit-users - with Found to https://groups.google.com/forum/#!forum/ensemble-toolkit-users
(line   35) redirect  https://groups.google.com/d/forum/ensemble-toolkit-dev - with Found to https://groups.google.com/forum/#!forum/ensemble-toolkit-dev
writing output... [ 71%] install
(line  167) ok        https://www.rabbitmq.com/download.html
(line  324) redirect  http://nerderati.com/2011/03/17/simplify-your-life-with-an-ssh-config-file/ - permanently to https://nerderati.com/2011/03/17/simplify-your-life-with-an-ssh-config-file/
(line  308) ok        http://linuxproblem.org/art_9.html
(line  248) redirect  http://radicalpilot.readthedocs.org - with Found to https://radicalpilot.readthedocs.io/en/stable/
(line  330) ok        https://github.com/vivek-bala/docs/blob/master/misc/gsissh_setup_stampede_ubuntu_xenial.sh
(line  330) ok        https://github.com/vivek-bala/docs/blob/master/misc/gsissh_setup_mac
writing output... [ 73%] introduction
(line   53) redirect  http://radicalpilot.readthedocs.org - with Found to https://radicalpilot.readthedocs.io/en/stable/
(line   75) redirect  http://radicalpilot.readthedocs.org - with Found to https://radicalpilot.readthedocs.io/en/stable/
(line   83) redirect  http://www.rabbitmq.com/ - permanently to https://www.rabbitmq.com/
(line   86) ok        https://pandas.pydata.org/
(line   75) redirect  http://radicalpilot.readthedocs.io/en/stable/machconf.html#writing-a-custom-resource-configuration-file - with Found to https://radicalpilot.readthedocs.io/en/stable/machconf.html#writing-a-custom-resource-configuration-file
(line   75) redirect  http://radicalpilot.readthedocs.io/en/stable/resources.html#chapter-resources - with Found to https://radicalpilot.readthedocs.io/en/stable/resources.html#chapter-resources
writing output... [ 76%] tests
(line   14) ok        https://travis-ci.com/radical-cybertools/radical.entk
(line   11) ok        https://codecov.io
(line   11) redirect  https://coverage.readthedocs.io/ - with Found to https://coverage.readthedocs.io/en/coverage-5.1/
(line   19) ok        https://codecov.io/gh/radical-cybertools/radical.entk
(line   19) ok        https://codecov.io/gh/radical-cybertools/radical.entk/branch/master/graph/badge.svg
(line   14) redirect  https://travis-ci.com/radical-cybertools/radical.entk.svg?branch=master - permanently to https://api.travis-ci.com/radical-cybertools/radical.entk.svg?branch=master
writing output... [ 78%] user_guide
writing output... [ 81%] user_guide/adding_data
writing output... [ 84%] user_guide/adding_pipelines
writing output... [ 86%] user_guide/adding_shared_data
writing output... [ 89%] user_guide/adding_stages
writing output... [ 92%] user_guide/adding_tasks
writing output... [ 94%] user_guide/change_target
writing output... [ 97%] user_guide/get_started
writing output... [100%] user_guide/profiling
(line   26) redirect  http://radicalanalytics.readthedocs.io - with Found to https://radicalanalytics.readthedocs.io/en/latest/
(line    7) redirect  http://radicalanalytics.readthedocs.io - with Found to https://radicalanalytics.readthedocs.io/en/latest/

build succeeded, 6 warnings.