Skip to content

rtd docs #20

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
thewtex merged 1 commit into from
Jan 17, 2025
Merged

rtd docs #20

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 7 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
ITKDoxygen
==========

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

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

[rtd-latest-img]: https://readthedocs.org/projects/itkdoxygen/badge/?version=latest
[rtd-latest-link]: https://app.readthedocs.org/projects/itkdoxygen/

Overview
--------

This dockerfile has been created to facilitate the creation of
This Dockerfile has been created to facilitate the creation of
[ITK](https://github.com/InsightSoftwareConsortium/ITK)
[Doxygen](https://doxygen.nl/)
documentation in a reproducible way.

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

To create the documentation locally, run the following commands:

Expand Down
Loading