osm-search/Nominatim
1
1
Fork 0
mirror of https://github.com/osm-search/Nominatim.git synced 2024-12-27 06:51:42 +03:00
Code Issues Packages Projects Releases Wiki Activity
7698f0672d
Nominatim/docs/CMakeLists.txt

35 lines
1.1 KiB
CMake
Raw Normal View History

initial version of documented CentOS7 vagrant script
2016-05-01 23:45:54 +03:00
# Auto-generated vagrant install documentation
use mkdocs for compiling the documentation Requires to shuffle around the documentation. make doc will now compile the documentation in the build directory. The markdowns created from the vagrant files are no longer versioned.
2018-01-15 01:43:15 +03:00
# build the actual documentation
initial version of documented CentOS7 vagrant script
2016-05-01 23:45:54 +03:00
use mkdocs for compiling the documentation Requires to shuffle around the documentation. make doc will now compile the documentation in the build directory. The markdowns created from the vagrant files are no longer versioned.
2018-01-15 01:43:15 +03:00
configure_file(mkdocs.yml ../mkdocs.yml)
file(MAKE_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/appendix)
initial version of documented CentOS7 vagrant script
2016-05-01 23:45:54 +03:00
cmake: restructure splitting between modules Make a clear distinction between parts used for the importer and parts used for the API.
2020-04-26 15:17:21 +03:00
set (DOC_SOURCES
admin
develop
api
docs: make customization chapter a separate section
2021-10-12 22:25:13 +03:00
customize
cmake: restructure splitting between modules Make a clear distinction between parts used for the importer and parts used for the API.
2020-04-26 15:17:21 +03:00
index.md
extra.css
styles.css
)
foreach (src ${DOC_SOURCES})
execute_process(
COMMAND ${CMAKE_COMMAND} -E create_symlink ${CMAKE_CURRENT_SOURCE_DIR}/${src} ${CMAKE_CURRENT_BINARY_DIR}/${src}
)
endforeach()
ADD_CUSTOM_TARGET(doc
Integrate Ubuntu 20 instructions into documentation
2020-05-07 01:36:13 +03:00
COMMAND ${CMAKE_CURRENT_SOURCE_DIR}/bash2md.sh ${PROJECT_SOURCE_DIR}/vagrant/Install-on-Ubuntu-20.sh ${CMAKE_CURRENT_BINARY_DIR}/appendix/Install-on-Ubuntu-20.md
Vagrant and CI tests for Ubuntu 22.04
2022-05-02 19:16:08 +03:00
COMMAND ${CMAKE_CURRENT_SOURCE_DIR}/bash2md.sh ${PROJECT_SOURCE_DIR}/vagrant/Install-on-Ubuntu-22.sh ${CMAKE_CURRENT_BINARY_DIR}/appendix/Install-on-Ubuntu-22.md
add mkdocstrings requirement for building docs mkdocstrings also needs access to the Python sources, so set a PYTHONPATH accordingly. This makes running mkdocs directly a bit awkward, therefore add a `make serve-doc` target.
2021-08-16 12:48:25 +03:00
COMMAND PYTHONPATH=${PROJECT_SOURCE_DIR} mkdocs build -d ${CMAKE_CURRENT_BINARY_DIR}/../site-html -f ${CMAKE_CURRENT_BINARY_DIR}/../mkdocs.yml
use mkdocs for compiling the documentation Requires to shuffle around the documentation. make doc will now compile the documentation in the build directory. The markdowns created from the vagrant files are no longer versioned.
2018-01-15 01:43:15 +03:00
)
make naming of documentation files consistent
2017-06-25 18:18:21 +03:00
add mkdocstrings requirement for building docs mkdocstrings also needs access to the Python sources, so set a PYTHONPATH accordingly. This makes running mkdocs directly a bit awkward, therefore add a `make serve-doc` target.
2021-08-16 12:48:25 +03:00
ADD_CUSTOM_TARGET(serve-doc
COMMAND PYTHONPATH=${PROJECT_SOURCE_DIR} mkdocs serve
WORKING_DIRECTORY ${PROJECT_BINARY_DIR}
)
Reference in New Issue Copy Permalink