anthony revisó este gist . Ir a la revisión
1 file changed, 8 insertions, 6 deletions
README.md
| @@ -1,11 +1,13 @@ | |||
| 1 | 1 | # Doxygen | |
| 2 | 2 | ||
| 3 | - | 1. Выполнить `docker buildx build -t axenov/doxygen .` | |
| 4 | - | 2. Разместить `Doxyfile` в корне проекта | |
| 5 | - | 3. В файле `Doxyfile` изменить `PROJECT_NAME` и `PROJECT_BRIEF` под проект | |
| 6 | - | 4. Удалить директорию `./docs/doxygen` | |
| 7 | - | 5. Из корня проекта запустить `docker run -it --rm -v $PWD:/data axenov/doxygen` и дождаться конца | |
| 8 | - | 6. Открыть в браузере файл `./docs/doxygen/html/index.html` | |
| 3 | + | 1. Выполнить `docker buildx build -t axenov/doxygen .` для создания образа | |
| 4 | + | 2. Выполнить `docker run -it --rm -v $PWD:/data axenov/doxygen -g Doxyfile` для генерации заготовки конфига | |
| 5 | + | 3. Для изменения `Doxyfile` можно пользоваться текстовым редаткором, либо использовать `doxywizard` из пакета `doxygen-gui` | |
| 6 | + | 4. Разместить `Doxyfile` в корне проекта | |
| 7 | + | 5. В файле `Doxyfile` изменить `PROJECT_NAME` и `PROJECT_BRIEF` под проект | |
| 8 | + | 6. Удалить директорию `./docs/doxygen` | |
| 9 | + | 7. Из корня проекта запустить `docker run -it --rm -v $PWD:/data axenov/doxygen` и дождаться конца | |
| 10 | + | 8. Открыть в браузере файл `./docs/doxygen/html/index.html` | |
| 9 | 11 | ||
| 10 | 12 | ## Доп. информация | |
| 11 | 13 | ||
anthony revisó este gist . Ir a la revisión
2 files changed, 24 insertions
Dockerfile(archivo creado)
| @@ -0,0 +1,12 @@ | |||
| 1 | + | FROM alpine:latest AS doxygen | |
| 2 | + | ||
| 3 | + | RUN apk add --no-cache \ | |
| 4 | + | doxygen \ | |
| 5 | + | graphviz \ | |
| 6 | + | fontconfig \ | |
| 7 | + | font-noto \ | |
| 8 | + | font-noto-emoji \ | |
| 9 | + | font-noto-cjk | |
| 10 | + | ||
| 11 | + | WORKDIR /data | |
| 12 | + | ENTRYPOINT ["doxygen"] | |
README.md(archivo creado)
| @@ -0,0 +1,12 @@ | |||
| 1 | + | # Doxygen | |
| 2 | + | ||
| 3 | + | 1. Выполнить `docker buildx build -t axenov/doxygen .` | |
| 4 | + | 2. Разместить `Doxyfile` в корне проекта | |
| 5 | + | 3. В файле `Doxyfile` изменить `PROJECT_NAME` и `PROJECT_BRIEF` под проект | |
| 6 | + | 4. Удалить директорию `./docs/doxygen` | |
| 7 | + | 5. Из корня проекта запустить `docker run -it --rm -v $PWD:/data axenov/doxygen` и дождаться конца | |
| 8 | + | 6. Открыть в браузере файл `./docs/doxygen/html/index.html` | |
| 9 | + | ||
| 10 | + | ## Доп. информация | |
| 11 | + | ||
| 12 | + | * https://www.doxygen.nl/manual/index.html | |