Skip to content

Commit 51b6b31

Browse files
ni-jfitzgerni-jfitzger
authored
Fix-badges-and-remove-links-to-old-documentation (#2005)
* Update project status links * Add documentation badges to individual status.incs * Update documentation.inc * Fix overall status table? * Update alt text for Documentation badges
1 parent 5719609 commit 51b6b31

File tree

22 files changed

+258
-90
lines changed

22 files changed

+258
-90
lines changed

‎README.rst‎

Lines changed: 78 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ Overall Status
22
--------------
33

44
+----------------------+------------------------------------------------------------------------------------------------------------------------------------+
5-
| master branch status | |BuildStatus| |Docs| |MITLicense| |CoverageStatus| |
5+
| master branch status | |BuildStatus| |MITLicense| |CoverageStatus| |
66
+----------------------+------------------------------------------------------------------------------------------------------------------------------------+
77
| GitHub status | |OpenIssues| |OpenPullRequests| |
88
+----------------------+------------------------------------------------------------------------------------------------------------------------------------+
@@ -12,21 +12,17 @@ Info Python bindings for NI Modular Instrument drivers. See `GitHub <htt
1212
Author NI
1313
=========== ============================================================================================================================
1414

15-
.. |BuildStatus| image:: https://img.shields.io/travis/ni/nimi-python.svg
15+
.. |BuildStatus| image:: https://api.travis-ci.com/ni/nimi-python.svg
1616
:alt: Build Status - master branch
1717
:target: https://travis-ci.org/ni/nimi-python
1818

19-
.. |Docs| image:: https://readthedocs.org/projects/nimi-python/badge/?version=latest
20-
:alt: Documentation Status - master branch
21-
:target: https://nimi-python.readthedocs.io/en/latest/?badge=latest
22-
2319
.. |MITLicense| image:: https://img.shields.io/badge/License-MIT-yellow.svg
2420
:alt: MIT License
2521
:target: https://opensource.org/licenses/MIT
2622

27-
.. |CoverageStatus| image:: https://coveralls.io/repos/github/ni/nimi-python/badge.svg?branch=master&dummy=no_cache_please_1
23+
.. |CoverageStatus| image:: https://codecov.io/github/ni/nimi-python/graph/badge.svg
2824
:alt: Test Coverage - master branch
29-
:target: https://coveralls.io/github/ni/nimi-python?branch=master
25+
:target: https://codecov.io/github/ni/nimi-python
3026

3127
.. |OpenIssues| image:: https://img.shields.io/github/issues/ni/nimi-python.svg
3228
:alt: Open Issues + Pull Requests
@@ -75,6 +71,8 @@ NI-DCPower Python API Status
7571
+-------------------------------+--------------------------+
7672
| Supported Python Version | |nidcpowerPythonVersion| |
7773
+-------------------------------+--------------------------+
74+
| Documentation | |nidcpowerDocs| |
75+
+-------------------------------+--------------------------+
7876
| Open Issues | |nidcpowerOpenIssues| |
7977
+-------------------------------+--------------------------+
8078
| Open Pull Requests | |nidcpowerOpenPRs| |
@@ -91,6 +89,11 @@ NI-DCPower Python API Status
9189
:target: http://pypi.python.org/pypi/nidcpower
9290

9391

92+
.. |nidcpowerDocs| image:: https://readthedocs.org/projects/nidcpower/badge/?version=latest
93+
:alt: NI-DCPower Python API Documentation Status
94+
:target: https://nidcpower.readthedocs.io/en/latest
95+
96+
9497
.. |nidcpowerOpenIssues| image:: https://img.shields.io/github/issues/ni/nimi-python/nidcpower.svg
9598
:alt: Open Issues + Pull Requests for NI-DCPower
9699
:target: https://github.com/ni/nimi-python/issues?q=is%3Aopen+is%3Aissue+label%3Anidcpower
@@ -114,6 +117,8 @@ NI-Digital Pattern Driver Python API Status
114117
+---------------------------------------+--------------------------+
115118
| Supported Python Version | |nidigitalPythonVersion| |
116119
+---------------------------------------+--------------------------+
120+
| Documentation | |nidigitalDocs| |
121+
+---------------------------------------+--------------------------+
117122
| Open Issues | |nidigitalOpenIssues| |
118123
+---------------------------------------+--------------------------+
119124
| Open Pull Requests | |nidigitalOpenPRs| |
@@ -130,6 +135,11 @@ NI-Digital Pattern Driver Python API Status
130135
:target: http://pypi.python.org/pypi/nidigital
131136

132137

138+
.. |nidigitalDocs| image:: https://readthedocs.org/projects/nidigital/badge/?version=latest
139+
:alt: NI-Digital Pattern Driver Python API Documentation Status
140+
:target: https://nidigital.readthedocs.io/en/latest
141+
142+
133143
.. |nidigitalOpenIssues| image:: https://img.shields.io/github/issues/ni/nimi-python/nidigital.svg
134144
:alt: Open Issues + Pull Requests for NI-Digital Pattern Driver
135145
:target: https://github.com/ni/nimi-python/issues?q=is%3Aopen+is%3Aissue+label%3Anidigital
@@ -153,6 +163,8 @@ NI-DMM Python API Status
153163
+-------------------------------+----------------------+
154164
| Supported Python Version | |nidmmPythonVersion| |
155165
+-------------------------------+----------------------+
166+
| Documentation | |nidmmDocs| |
167+
+-------------------------------+----------------------+
156168
| Open Issues | |nidmmOpenIssues| |
157169
+-------------------------------+----------------------+
158170
| Open Pull Requests | |nidmmOpenPRs| |
@@ -169,6 +181,11 @@ NI-DMM Python API Status
169181
:target: http://pypi.python.org/pypi/nidmm
170182

171183

184+
.. |nidmmDocs| image:: https://readthedocs.org/projects/nidmm/badge/?version=latest
185+
:alt: NI-DMM Python API Documentation Status
186+
:target: https://nidmm.readthedocs.io/en/latest
187+
188+
172189
.. |nidmmOpenIssues| image:: https://img.shields.io/github/issues/ni/nimi-python/nidmm.svg
173190
:alt: Open Issues + Pull Requests for NI-DMM
174191
:target: https://github.com/ni/nimi-python/issues?q=is%3Aopen+is%3Aissue+label%3Anidmm
@@ -192,6 +209,8 @@ NI-FGEN Python API Status
192209
+-------------------------------+-----------------------+
193210
| Supported Python Version | |nifgenPythonVersion| |
194211
+-------------------------------+-----------------------+
212+
| Documentation | |nifgenDocs| |
213+
+-------------------------------+-----------------------+
195214
| Open Issues | |nifgenOpenIssues| |
196215
+-------------------------------+-----------------------+
197216
| Open Pull Requests | |nifgenOpenPRs| |
@@ -208,6 +227,11 @@ NI-FGEN Python API Status
208227
:target: http://pypi.python.org/pypi/nifgen
209228

210229

230+
.. |nifgenDocs| image:: https://readthedocs.org/projects/nifgen/badge/?version=latest
231+
:alt: NI-FGEN Python API Documentation Status
232+
:target: https://nifgen.readthedocs.io/en/latest
233+
234+
211235
.. |nifgenOpenIssues| image:: https://img.shields.io/github/issues/ni/nimi-python/nifgen.svg
212236
:alt: Open Issues + Pull Requests for NI-FGEN
213237
:target: https://github.com/ni/nimi-python/issues?q=is%3Aopen+is%3Aissue+label%3Anifgen
@@ -231,6 +255,8 @@ NI-ModInst Python API Status
231255
+-------------------------------+--------------------------+
232256
| Supported Python Version | |nimodinstPythonVersion| |
233257
+-------------------------------+--------------------------+
258+
| Documentation | |nimodinstDocs| |
259+
+-------------------------------+--------------------------+
234260
| Open Issues | |nimodinstOpenIssues| |
235261
+-------------------------------+--------------------------+
236262
| Open Pull Requests | |nimodinstOpenPRs| |
@@ -247,6 +273,11 @@ NI-ModInst Python API Status
247273
:target: http://pypi.python.org/pypi/nimodinst
248274

249275

276+
.. |nimodinstDocs| image:: https://readthedocs.org/projects/nimodinst/badge/?version=latest
277+
:alt: NI-ModInst Python API Documentation Status
278+
:target: https://nimodinst.readthedocs.io/en/latest
279+
280+
250281
.. |nimodinstOpenIssues| image:: https://img.shields.io/github/issues/ni/nimi-python/nimodinst.svg
251282
:alt: Open Issues + Pull Requests for NI-ModInst
252283
:target: https://github.com/ni/nimi-python/issues?q=is%3Aopen+is%3Aissue+label%3Animodinst
@@ -270,6 +301,8 @@ NI-SCOPE Python API Status
270301
+-------------------------------+------------------------+
271302
| Supported Python Version | |niscopePythonVersion| |
272303
+-------------------------------+------------------------+
304+
| Documentation | |niscopeDocs| |
305+
+-------------------------------+------------------------+
273306
| Open Issues | |niscopeOpenIssues| |
274307
+-------------------------------+------------------------+
275308
| Open Pull Requests | |niscopeOpenPRs| |
@@ -286,6 +319,11 @@ NI-SCOPE Python API Status
286319
:target: http://pypi.python.org/pypi/niscope
287320

288321

322+
.. |niscopeDocs| image:: https://readthedocs.org/projects/niscope/badge/?version=latest
323+
:alt: NI-SCOPE Python API Documentation Status
324+
:target: https://niscope.readthedocs.io/en/latest
325+
326+
289327
.. |niscopeOpenIssues| image:: https://img.shields.io/github/issues/ni/nimi-python/niscope.svg
290328
:alt: Open Issues + Pull Requests for NI-SCOPE
291329
:target: https://github.com/ni/nimi-python/issues?q=is%3Aopen+is%3Aissue+label%3Aniscope
@@ -309,6 +347,8 @@ NI Switch Executive Python API Status
309347
+-------------------------------+---------------------+
310348
| Supported Python Version | |nisePythonVersion| |
311349
+-------------------------------+---------------------+
350+
| Documentation | |niseDocs| |
351+
+-------------------------------+---------------------+
312352
| Open Issues | |niseOpenIssues| |
313353
+-------------------------------+---------------------+
314354
| Open Pull Requests | |niseOpenPRs| |
@@ -325,6 +365,11 @@ NI Switch Executive Python API Status
325365
:target: http://pypi.python.org/pypi/nise
326366

327367

368+
.. |niseDocs| image:: https://readthedocs.org/projects/nise/badge/?version=latest
369+
:alt: NI Switch Executive Python API Documentation Status
370+
:target: https://nise.readthedocs.io/en/latest
371+
372+
328373
.. |niseOpenIssues| image:: https://img.shields.io/github/issues/ni/nimi-python/nise.svg
329374
:alt: Open Issues + Pull Requests for NI Switch Executive
330375
:target: https://github.com/ni/nimi-python/issues?q=is%3Aopen+is%3Aissue+label%3Anise
@@ -348,6 +393,8 @@ NI-SWITCH Python API Status
348393
+-------------------------------+-------------------------+
349394
| Supported Python Version | |niswitchPythonVersion| |
350395
+-------------------------------+-------------------------+
396+
| Documentation | |niswitchDocs| |
397+
+-------------------------------+-------------------------+
351398
| Open Issues | |niswitchOpenIssues| |
352399
+-------------------------------+-------------------------+
353400
| Open Pull Requests | |niswitchOpenPRs| |
@@ -364,6 +411,11 @@ NI-SWITCH Python API Status
364411
:target: http://pypi.python.org/pypi/niswitch
365412

366413

414+
.. |niswitchDocs| image:: https://readthedocs.org/projects/niswitch/badge/?version=latest
415+
:alt: NI-SWITCH Python API Documentation Status
416+
:target: https://niswitch.readthedocs.io/en/latest
417+
418+
367419
.. |niswitchOpenIssues| image:: https://img.shields.io/github/issues/ni/nimi-python/niswitch.svg
368420
:alt: Open Issues + Pull Requests for NI-SWITCH
369421
:target: https://github.com/ni/nimi-python/issues?q=is%3Aopen+is%3Aissue+label%3Aniswitch
@@ -387,6 +439,8 @@ NI-TClk Python API Status
387439
+-------------------------------+-----------------------+
388440
| Supported Python Version | |nitclkPythonVersion| |
389441
+-------------------------------+-----------------------+
442+
| Documentation | |nitclkDocs| |
443+
+-------------------------------+-----------------------+
390444
| Open Issues | |nitclkOpenIssues| |
391445
+-------------------------------+-----------------------+
392446
| Open Pull Requests | |nitclkOpenPRs| |
@@ -403,6 +457,11 @@ NI-TClk Python API Status
403457
:target: http://pypi.python.org/pypi/nitclk
404458

405459

460+
.. |nitclkDocs| image:: https://readthedocs.org/projects/nitclk/badge/?version=latest
461+
:alt: NI-TClk Python API Documentation Status
462+
:target: https://nitclk.readthedocs.io/en/latest
463+
464+
406465
.. |nitclkOpenIssues| image:: https://img.shields.io/github/issues/ni/nimi-python/nitclk.svg
407466
:alt: Open Issues + Pull Requests for NI-TClk
408467
:target: https://github.com/ni/nimi-python/issues?q=is%3Aopen+is%3Aissue+label%3Anitclk
@@ -475,7 +534,17 @@ as we can.
475534
Documentation
476535
=============
477536

478-
Documentation is available `here <http://nimi-python.readthedocs.io>`_.
537+
Documentation is available on **Read the Docs**:
538+
539+
- https://nidcpower.readthedocs.io/en/stable
540+
- https://nidigital.readthedocs.io/en/stable
541+
- https://nidmm.readthedocs.io/en/stable
542+
- https://nifgen.readthedocs.io/en/stable
543+
- https://nimodinst.readthedocs.io/en/stable
544+
- https://niscope.readthedocs.io/en/stable
545+
- https://nise.readthedocs.io/en/stable
546+
- https://niswitch.readthedocs.io/en/stable
547+
- https://nitclk.readthedocs.io/en/stable
479548

480549

481550
.. _license-section:

‎build/templates/status.inc.mako‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ table_contents.append(['{0} ({1})'.format(driver_name, module_name), '', ])
1414
table_contents.append(['Driver Version Tested Against', config['latest_runtime_version_tested_against']])
1515
table_contents.append(['PyPI Version', '|{0}LatestVersion|'.format(module_name)])
1616
table_contents.append(['Supported Python Version', '|{0}PythonVersion|'.format(module_name)])
17+
table_contents.append(['Documentation', '|{0}Docs|'.format(module_name)])
1718
table_contents.append(['Open Issues', '|{0}OpenIssues|'.format(module_name)])
1819
table_contents.append(['Open Pull Requests', '|{0}OpenPRs|'.format(module_name)])
1920
@@ -29,6 +30,8 @@ ${helper.get_rst_picture_reference('{0}LatestVersion'.format(module_name), 'http
2930

3031
${helper.get_rst_picture_reference('{0}PythonVersion'.format(module_name), 'http://img.shields.io/pypi/pyversions/{0}.svg'.format(module_name), '{0} supported Python versions'.format(driver_name), 'http://pypi.python.org/pypi/{0}'.format(module_name), indent=0)}
3132

33+
${helper.get_rst_picture_reference('{0}Docs'.format(module_name), 'https://readthedocs.org/projects/{0}/badge/?version=latest'.format(module_name), '{0} Python API Documentation Status'.format(driver_name), 'https://{0}.readthedocs.io/en/latest'.format(module_name), indent=0)}
34+
3235
${helper.get_rst_picture_reference('{0}OpenIssues'.format(module_name), 'https://img.shields.io/github/issues/ni/nimi-python/{0}.svg'.format(module_name), 'Open Issues + Pull Requests for {0}'.format(driver_name), 'https://github.com/ni/nimi-python/issues?q=is%3Aopen+is%3Aissue+label%3A{0}'.format(module_name), indent=0)}
3336

3437
${helper.get_rst_picture_reference('{0}OpenPRs'.format(module_name), 'https://img.shields.io/github/issues-pr/ni/nimi-python/{0}.svg'.format(module_name), 'Pull Requests for {0}'.format(driver_name), 'https://github.com/ni/nimi-python/pulls?q=is%3Aopen+is%3Aissue+label%3A{0}'.format(module_name), indent=0)}

‎docs/_static/documentation.inc‎

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,16 @@
33
Documentation
44
=============
55

6-
Documentation is available `here <http://nimi-python.readthedocs.io>`_.
6+
Documentation is available on **Read the Docs**:
7+
8+
- https://nidcpower.readthedocs.io/en/stable
9+
- https://nidigital.readthedocs.io/en/stable
10+
- https://nidmm.readthedocs.io/en/stable
11+
- https://nifgen.readthedocs.io/en/stable
12+
- https://nimodinst.readthedocs.io/en/stable
13+
- https://niscope.readthedocs.io/en/stable
14+
- https://nise.readthedocs.io/en/stable
15+
- https://niswitch.readthedocs.io/en/stable
16+
- https://nitclk.readthedocs.io/en/stable
717

818

‎docs/_static/status_project.inc‎

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ Overall Status
22
--------------
33

44
+----------------------+------------------------------------------------------------------------------------------------------------------------------------+
5-
| master branch status | |BuildStatus| |Docs| |MITLicense| |CoverageStatus| |
5+
| master branch status | |BuildStatus| |MITLicense| |CoverageStatus| |
66
+----------------------+------------------------------------------------------------------------------------------------------------------------------------+
77
| GitHub status | |OpenIssues| |OpenPullRequests| |
88
+----------------------+------------------------------------------------------------------------------------------------------------------------------------+
@@ -12,21 +12,17 @@ Info Python bindings for NI Modular Instrument drivers. See `GitHub <htt
1212
Author NI
1313
=========== ============================================================================================================================
1414

15-
.. |BuildStatus| image:: https://img.shields.io/travis/ni/nimi-python.svg
15+
.. |BuildStatus| image:: https://api.travis-ci.com/ni/nimi-python.svg
1616
:alt: Build Status - master branch
1717
:target: https://travis-ci.org/ni/nimi-python
1818

19-
.. |Docs| image:: https://readthedocs.org/projects/nimi-python/badge/?version=latest
20-
:alt: Documentation Status - master branch
21-
:target: https://nimi-python.readthedocs.io/en/latest/?badge=latest
22-
2319
.. |MITLicense| image:: https://img.shields.io/badge/License-MIT-yellow.svg
2420
:alt: MIT License
2521
:target: https://opensource.org/licenses/MIT
2622

27-
.. |CoverageStatus| image:: https://coveralls.io/repos/github/ni/nimi-python/badge.svg?branch=master&dummy=no_cache_please_1
23+
.. |CoverageStatus| image:: https://codecov.io/github/ni/nimi-python/graph/badge.svg
2824
:alt: Test Coverage - master branch
29-
:target: https://coveralls.io/github/ni/nimi-python?branch=master
25+
:target: https://codecov.io/github/ni/nimi-python
3026

3127
.. |OpenIssues| image:: https://img.shields.io/github/issues/ni/nimi-python.svg
3228
:alt: Open Issues + Pull Requests

‎docs/nidcpower/status.inc‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@ NI-DCPower Python API Status
1111
+-------------------------------+--------------------------+
1212
| Supported Python Version | |nidcpowerPythonVersion| |
1313
+-------------------------------+--------------------------+
14+
| Documentation | |nidcpowerDocs| |
15+
+-------------------------------+--------------------------+
1416
| Open Issues | |nidcpowerOpenIssues| |
1517
+-------------------------------+--------------------------+
1618
| Open Pull Requests | |nidcpowerOpenPRs| |
@@ -27,6 +29,11 @@ NI-DCPower Python API Status
2729
:target: http://pypi.python.org/pypi/nidcpower
2830

2931

32+
.. |nidcpowerDocs| image:: https://readthedocs.org/projects/nidcpower/badge/?version=latest
33+
:alt: NI-DCPower Python API Documentation Status
34+
:target: https://nidcpower.readthedocs.io/en/latest
35+
36+
3037
.. |nidcpowerOpenIssues| image:: https://img.shields.io/github/issues/ni/nimi-python/nidcpower.svg
3138
:alt: Open Issues + Pull Requests for NI-DCPower
3239
:target: https://github.com/ni/nimi-python/issues?q=is%3Aopen+is%3Aissue+label%3Anidcpower

‎docs/nidigital/status.inc‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@ NI-Digital Pattern Driver Python API Status
1111
+---------------------------------------+--------------------------+
1212
| Supported Python Version | |nidigitalPythonVersion| |
1313
+---------------------------------------+--------------------------+
14+
| Documentation | |nidigitalDocs| |
15+
+---------------------------------------+--------------------------+
1416
| Open Issues | |nidigitalOpenIssues| |
1517
+---------------------------------------+--------------------------+
1618
| Open Pull Requests | |nidigitalOpenPRs| |
@@ -27,6 +29,11 @@ NI-Digital Pattern Driver Python API Status
2729
:target: http://pypi.python.org/pypi/nidigital
2830

2931

32+
.. |nidigitalDocs| image:: https://readthedocs.org/projects/nidigital/badge/?version=latest
33+
:alt: NI-Digital Pattern Driver Python API Documentation Status
34+
:target: https://nidigital.readthedocs.io/en/latest
35+
36+
3037
.. |nidigitalOpenIssues| image:: https://img.shields.io/github/issues/ni/nimi-python/nidigital.svg
3138
:alt: Open Issues + Pull Requests for NI-Digital Pattern Driver
3239
:target: https://github.com/ni/nimi-python/issues?q=is%3Aopen+is%3Aissue+label%3Anidigital

0 commit comments

Comments
 (0)