Skip to content

Commit

Permalink
build: remove doc target (#66)
Browse files Browse the repository at this point in the history
* ci: modify `deploy-documentation` job to call `doxygen` command directly

* build: remove unused `doc.cmake` module

* docs(readme): update guide for generating documentation
  • Loading branch information
threeal authored Jun 18, 2024
1 parent 2accea6 commit c9b55a9
Show file tree
Hide file tree
Showing 4 changed files with 4 additions and 19 deletions.
14 changes: 2 additions & 12 deletions .github/workflows/deploy-documentation.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,29 +18,19 @@ jobs:
steps:
- name: Checkout this repository
uses: actions/[email protected]
with:
path: musen

- name: Install documentation dependencies
run: |
sudo apt-get update
sudo apt-get install -y doxygen
- name: Create a build directory
run: mkdir build

- name: Configure CMake
working-directory: build
run: cmake ../musen

- name: Build documentation
working-directory: build
run: make doc
run: doxygen

- name: Upload Documentation
uses: actions/[email protected]
with:
path: musen/doc
path: doc

- name: Deploy Pages
id: deploy-pages
Expand Down
2 changes: 0 additions & 2 deletions CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,6 @@ install(TARGETS ${PROJECT_NAME}

add_subdirectory("examples")

include("cmake/doc.cmake")

if(BUILD_TESTING)
enable_testing()
add_subdirectory("test/gtest")
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,9 +40,9 @@ See [releases](https://github.com/ichiro-its/musen/releases) for the latest vers
$ cmake .. && make
```
> Optionally, you could speed up the build process by specifying the parallel job using `-j` option, see [this](https://www.gnu.org/software/make/manual/html_node/Parallel.html).
- (Optional) generate documentation using the configured CMake.
- (Optional) generate documentation.
```sh
$ make doc
$ doxygen
```
- (Optional) reconfigure CMake to build a Debian packages.
```sh
Expand Down
3 changes: 0 additions & 3 deletions cmake/doc.cmake

This file was deleted.

0 comments on commit c9b55a9

Please sign in to comment.