Skip to content

Commit

Permalink
Merge branch 'doxygen_test' into 'master'
Browse files Browse the repository at this point in the history
Refactoring Documents

Closes #108

See merge request ricos/monolish!436
  • Loading branch information
Toshiaki Hishinuma committed Jan 11, 2022
2 parents b3c23d6 + fbe4f92 commit 12757f9
Show file tree
Hide file tree
Showing 31 changed files with 1,778 additions and 320 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ https://keepachangelog.com/ja/1.0.0/ に基づいて記述していく
Unreleased
-----------
### Added
- Refactoring documents https://gitlab.ritc.jp/ricos/monolish/-/merge_requests/436 https://github.com/ricosjp/monolish/issues/108
- Add explanation of link_monolish_gpu.sh https://gitlab.ritc.jp/ricos/monolish/-/merge_requests/434 https://github.com/ricosjp/monolish/issues/102
- Add get_final_resid() and get_final_iter() in equations and eigens https://gitlab.ritc.jp/ricos/monolish/-/merge_requests/433 https://github.com/ricosjp/monolish/issues/103

Expand Down
3 changes: 2 additions & 1 deletion Doxyfile.in
Original file line number Diff line number Diff line change
Expand Up @@ -829,7 +829,8 @@ WARN_LOGFILE =
# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
# Note: If this tag is empty the current directory is searched.

INPUT = ${PROJECT_SOURCE_DIR}/include/ \
INPUT = ${PROJECT_SOURCE_DIR}/include/monolish_doxygen_list.hpp \
${PROJECT_SOURCE_DIR}/include/ \
${CMAKE_CURRENT_BINARY_DIR}/doc/

# This tag can be used to specify the character encoding of the source files
Expand Down
25 changes: 13 additions & 12 deletions doc/monolish.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,10 +39,11 @@ Please see [CPU Examples](@ref cpu_dev) and [GPU Examples](@ref gpu_dev) for mor
- [GPU Examples](@ref gpu_dev)

### API Overview
- [Data types](@ref data_type)
- [Supported Operations](@ref oplist)
- [Linear Solvers](@ref solverlist)
- [Performance logging and find bottlenecks](@ref logger)
- [**Modules**](./modules.html)
- [Data types](@ref data_type)
- [Supported Operations](@ref oplist)
- [Linear Solvers](@ref solverlist)
- [Performance logging and find bottlenecks](@ref logger)

## For Developers
- [Build monolish from source code](@ref build_guide)
Expand All @@ -53,13 +54,13 @@ Please see [CPU Examples](@ref cpu_dev) and [GPU Examples](@ref gpu_dev) for mor
- [Publications](@ref publications)

## Links
- [Source code](https://github.com/ricosjp/monolish/)
- [Documentation](https://ricosjp.github.io/monolish/)
- [Bug reports](https://github.com/ricosjp/monolish/issues)
- [Releases](https://github.com/ricosjp/monolish/releases)
- [Changelog](https://github.com/ricosjp/monolish/blob/master/CHANGELOG.md)
- [Licence](https://github.com/ricosjp/monolish/blob/master/LICENSE)
- [monolish log viewer](https://pypi.org/project/monolish-log-viewer/)
- [Continuous benchmarking](https://ricosjp.github.io/monolish_benchmark_result/)
- [**Source code**](https://github.com/ricosjp/monolish/)
- [**Documentation**](https://ricosjp.github.io/monolish/)
- [**Bug reports**](https://github.com/ricosjp/monolish/issues)
- [**Releases**](https://github.com/ricosjp/monolish/releases)
- [**Changelog**](https://github.com/ricosjp/monolish/blob/master/CHANGELOG.md)
- [**Licence**](https://github.com/ricosjp/monolish/blob/master/LICENSE)
- [**monolish log viewer**](https://pypi.org/project/monolish-log-viewer/)
- [**Continuous benchmarking**](https://ricosjp.github.io/monolish_benchmark_result/)

Copyright 2021 [RICOS Co. Ltd.](https://www.ricos.co.jp/)
Loading

0 comments on commit 12757f9

Please sign in to comment.