Skip to content

Commit 792a7e6

Browse files
authored
Merge pull request #20 from thewtex/rtd-docs
rtd docs
2 parents 4706dc6 + 8ba9d96 commit 792a7e6

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

README.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
ITKDoxygen
22
==========
33

4-
[![][doxygen-img]][doxygen-link] [![][deployment-img]][deployment-link] [![][build-docker-img]][build-docker-link]
4+
[![][doxygen-img]][doxygen-link] [![][deployment-img]][deployment-link] [![][build-docker-img]][build-docker-link] [![][rtd-latest-img]][rtd-latest-link]
55

66
[doxygen-img]: https://github.com/InsightSoftwareConsortium/ITKDoxygen/actions/workflows/Doxygen.yml/badge.svg
77
[doxygen-link]: https://github.com/InsightSoftwareConsortium/ITKDoxygen/actions/workflows/Doxygen.yml
@@ -12,16 +12,20 @@ ITKDoxygen
1212
[build-docker-img]: https://github.com/InsightSoftwareConsortium/ITKDoxygen/actions/workflows/build-docker-image.yml/badge.svg
1313
[build-docker-link]: https://github.com/InsightSoftwareConsortium/ITKDoxygen/actions/workflows/build-docker-image.yml
1414

15+
[rtd-latest-img]: https://readthedocs.org/projects/itkdoxygen/badge/?version=latest
16+
[rtd-latest-link]: https://app.readthedocs.org/projects/itkdoxygen/
17+
1518
Overview
1619
--------
1720

18-
This dockerfile has been created to facilitate the creation of
21+
This Dockerfile has been created to facilitate the creation of
1922
[ITK](https://github.com/InsightSoftwareConsortium/ITK)
2023
[Doxygen](https://doxygen.nl/)
2124
documentation in a reproducible way.
2225

23-
The documentation is built nightly on the current/latest ITK commit,
26+
The documentation is built nightly on the current/latest ITK commit,
2427
and deployed to GitHub pages at: https://insightsoftwareconsortium.github.io/ITKDoxygen/
28+
and to ReadTheDocs at: https://docs.itk.org/projects/doxygen/
2529

2630
To create the documentation locally, run the following commands:
2731

0 commit comments

Comments
 (0)