links to correct

[HelgaMond]

These link are to be updated or corrected

» Developer’s Guide » Tango Client » Writing a TANGO client using TANGO C++ APIs Reconnection and exception See Reconnection and exception for more details on this subject - links to the same section https://tango-controls.readthedocs.io/en/dev/development/client-api/cpp-client-programmers-guide.html#reconnection-and-exception

» Device Servers » TANGO Device Server Guidelines » Guidelines Note Throughout the rest of the document, the issued recommendations are specified as below: The recommendation is to … https://tango-controls.readthedocs.io/en/dev/development/device-api/ds-guideline/device-server-guidelines.html

» Debugging and Testing » Using Tango docker containers [TODO script] https://tango-controls.readthedocs.io/en/dev/development/debugging-and-testing/testing-tango-using-docker.html#extending-existing-containers

» Advanced » Tango REST API » References https://tango-controls.readthedocs.io/en/dev/development/advanced/rest-api.html

» Tools and Extensions » Tango Application Toolkit “ATK” » Tango ATK Tutorial Using the ATK MultiScalarTableViewer (Flash demo) http://www.esrf.eu/computing/cs/tango/tango_doc/atk_tutorial/flash-demos/MultiScalarTableViewer.htm

» Tools and Extensions » Tango Application Toolkit “ATK” » Tango ATK Tutorial Getting Started (Flash Demo) http://www.esrf.eu/computing/cs/tango/tango_doc/atk_tutorial/flash-demos/GettingStarted.htm

» Tools and Extensions » Tango Application Toolkit “ATK” » Tango ATK Tutorial ATK application skeleton (Flash Slide Show) http://www.esrf.eu/computing/cs/tango/tango_doc/atk_tutorial/flash-demos/AtkSkeleton.htm

» Tools and Extensions » Tango Application Toolkit “ATK” » Tango ATK Tutorial ATK application project using NetBeans (Flash Demo) http://www.esrf.eu/computing/cs/tango/tango_doc/atk_tutorial/flash-demos/NetBeansATK1.htm

» Tools and Extensions » Tango Application Toolkit “ATK” » Tango ATK Tutorial First ATK Simple GUI appliction (Flash Demo) http://www.esrf.eu/computing/cs/tango/tango_doc/atk_tutorial/flash-demos/NetBeansATK2.htm

» Tools and Extensions » Tango Application Toolkit “ATK” » Tango ATK Tutorial State and Status viewers (flash demo) http://www.esrf.eu/computing/cs/tango/tango_doc/atk_tutorial/flash-demos/StateStatusViewer.htm

» Tools and Extensions » Tango Application Toolkit “ATK” » Tango ATK Tutorial ScalarListViewers and ScalarListSetters (Flash Demo) http://www.esrf.eu/computing/cs/tango/tango_doc/atk_tutorial/flash-demos/AttListViewersAndSetters.htm

» Tools and Extensions » Tango Application Toolkit “ATK” » Tango ATK Tutorial Generic single device panel (Flash demo) http://www.esrf.eu/computing/cs/tango/tango_doc/atk_tutorial/flash-demos/DevPanel.htm

» Tools and Extensions » Tango Application Toolkit “ATK” » Tango ATK Tutorial Using the ATK Trend (Flash demo) http://www.esrf.eu/computing/cs/tango/tango_doc/atk_tutorial/flash-demos/TrendDemo.htm

» Tools and Extensions » Taurus (Python GUI library) You can find its full documentation here - no link to "here"

» Tools and Extensions » Panorama Next link does't link to the Next page in the table of contents. https://tango-controls.readthedocs.io/en/dev/tools-and-extensions/bindings/panorama.html

Tango REST API There are 2 places where Tango REST API is: Advanced and Tools and Extensions - Next and Privios links don't work https://tango-controls.readthedocs.io/en/dev/development/advanced/rest-api.html

» Tools and Extensions » PANIC Alarm System The PANIC 0.x UI manual - 404 error https://tango-controls.readthedocs.io/en/dev/tools-and-extensions/alarm/panic.html

[PhilLAL]

During tango-doc built with sphinx, following warning are displayed. Perhaps they can be used to complete/correct some links?

source/administration/services/hdbpp/index.rst:8: WARNING: term not in glossary: hdb++ source/development/contributing/documentation-guide.rst:68: WARNING: unknown document: tutorials/documentation-workflow-tutorial source/getting-started/first-steps.rst:14: WARNING: unknown document: intsallation/index source/installation/minimum-deployment.rst:105: WARNING: undefined label: administration/deployment/without-sql-db.html (if the link has no caption the label must precede a section header) source/installation/tango-on-windows.rst:156: WARNING: term not in glossary: device servers source/installation/tango-on-windows.rst:164: WARNING: term not in glossary: device servers source/reference/glossary.rst:53: WARNING: term not in glossary: attribute quality source/tools-and-extensions/astor/config.rst:23: WARNING: unknown option: -DNO_PREF=true source/tools-and-extensions/atk/atk.rst:513: WARNING: Could not lex literal_block as "java". Highlighting skipped. source/tools-and-extensions/atk/atk.rst:573: WARNING: Could not lex literal_block as "java". Highlighting skipped. source/tools-and-extensions/atk/atk.rst:599: WARNING: Could not lex literal_block as "java". Highlighting skipped. source/tools-and-extensions/atk/atk.rst:961: WARNING: Could not lex literal_block as "java". Highlighting skipped. source/tools-and-extensions/atk/atk.rst:1046: WARNING: Could not lex literal_block as "java". Highlighting skipped. source/tools-and-extensions/atk/atk.rst:1477: WARNING: Could not lex literal_block as "java". Highlighting skipped. source/tools-and-extensions/atk/atk.rst:1486: WARNING: Could not lex literal_block as "java". Highlighting skipped. source/tools-and-extensions/atk/atk.rst:1495: WARNING: Could not lex literal_block as "java". Highlighting skipped. source/tools-and-extensions/jdraw/jdraw.rst:281: WARNING: Could not lex literal_block as "java". Highlighting skipped. source/tutorials-and-howtos/how-tos/how-to-create-inheritance-link.rst:64: WARNING: Could not lex literal_block as "cpp". Highlighting skipped. source/tutorials-and-howtos/how-tos/how-use-vectors-set-attributes.rst:42: WARNING: Could not lex literal_block as "python". Highlighting skipped. source/installation/minimum-deployment.rst:109: WARNING: undefined label: administration/deployment/without-sql-db.html (if the link has no caption the label must precede a section header)

[HelgaMond]

https://tango-controls.readthedocs.io/en/latest/tutorials-and-howtos/how-tos/how-to-compile-mniorb.html The omniORB Wiki and experiments done by ESRF colleagues have been used to write this HowTo. - Wiki link is missing

[PhilLAL]

Hi, reading LogViewer part, I noticed that [sec:blabla] all appears as raw and without any link. I am not a sphinx expert but I would suggest a ref:blabla change.

A quick search into the repo tango-doc show [ref:XXX] are in several sections:

• [sec:dev] and [sec:corba] in source/development/device-api/device-server-model.rst
  • [sec:dev] could probably link to https://tango-controls.readthedocs.io/en/latest/development/device-api/device-server-model.html#the-device
  • [sec:corba] could probably link to https://tango-controls.readthedocs.io/en/latest/development/device-api/device-server-model.html#introduction-to-corba
• 3 [sec:Tango-log-consumer] in source/development/advanced/reference.rst which probably should link to https://tango-controls.readthedocs.io/en/latest/development/advanced/reference.html#tango-log-consumer
• [sec:The-Tango-Logging] and [sec:Tango-log-consumer] in source/development/device-api/device-server-writing.rst
  • [sec:The-Tango-Logging] which does not correspond to an existing section
  • [sec:Tango-log-consumer] which should probably link to https://tango-controls.readthedocs.io/en/latest/development/advanced/reference.html#tango-log-consumer This syntax does not seem to exist in Sphinx restructuredText format so this is probably relics from the former doc format.

I also noticed following dead links in development/device-api/device-server-writing.rst:

• [Writing_chapter] which does not correspond to an existing section
• 2 [Auto_cmd] which could link to https://tango-controls.readthedocs.io/en/latest/development/advanced/reference.html#automatically-added-commands
• [Voc]
• [sec:Tango-log-consumer] which should probably link to https://tango-controls.readthedocs.io/en/latest/development/advanced/reference.html#tango-log-consumer
• [sub:C++-logging-in]
• [The-Tango-Logging chapter]
• [Server_startup]
• [DServer_class]
• [Inheriting]
• [Device pattern figure]
• [Compiling NT] This syntax is used for citations but they do not appear in source/reference/bibliography.rst and these titles could be be section titles or forgotten references in the bibliography.

Some of these sections have probably been renamed so if other people can confirm, it would help. Cheers.

[PhilLAL]

I ran a find . -name "*.rst" -print | xargs grep "TODO"into a tango-doc clone and here is what I found:

./source/development/client-api/cpp-client-programmers-guide.rst:.. TODO - reference to read the docs ?
./source/development/advanced/rest-api.rst:Here one uses Tango REST API implementation related to version RC4 [TODO link to the branch] this relates to
./source/development/debugging-and-testing/testing-tango-using-docker.rst:[TODO script]
./source/tools-and-extensions/web/canone.rst:The TODO list
./source/getting-started/development/java/jtango-server.rst:Assuming that Tango-Controls environment is set up properly (TODO ref) and MyDevice/development (TODO ref) server is defined in the Tango Database the later command will start the device server.
./source/tutorials-and-howtos/how-tos/how-to-use-tango-servers-without-db.rst:                //TODO define executable according to current OS
./source/tutorials-and-howtos/how-tos/how-to-use-tango-servers-without-db.rst:                //TODO other platforms or rely on the environmet
./source/tutorials-and-howtos/how-tos/how-to-use-tango-servers-without-db.rst://TODO
./source/tutorials-and-howtos/how-tos/how-to-use-tango-servers-without-db.rst://TODO 
./source/tutorials-and-howtos/how-tos/how-to-distinguish-clients-on-the-server-side.rst:TODO
./source/tutorials-and-howtos/how-tos/how-to-distinguish-clients-on-the-server-side.rst:TODO

I also saw some typos:

• :term:<Tango Hosts Tango Host> in ./source/development/advanced/rest-api.rst#tango-rest-api-specification for instance