Skip to content

Commit

Permalink
update the documentation
Browse files Browse the repository at this point in the history
- Update the "Getting Started" page
- Update the examples page
- Add automatic page titles for all documentation pages
- Add new URI redirects for the wwwdocs
  • Loading branch information
asmuth committed May 14, 2020
1 parent 1b72664 commit 809eea6
Show file tree
Hide file tree
Showing 14 changed files with 782 additions and 366 deletions.
3 changes: 3 additions & 0 deletions .gitignore
Expand Up @@ -21,3 +21,6 @@ install_manifest.txt
wwwdocs
config.h
test-results

# Local Netlify folder
.netlify
13 changes: 13 additions & 0 deletions CMakeLists.txt
Expand Up @@ -123,3 +123,16 @@ add_custom_target(doc
COMMAND mkdir -p ${CMAKE_CURRENT_BINARY_DIR}/wwwdocs
COMMAND ${CMAKE_CURRENT_SOURCE_DIR}/doc/web/build.sh ${CMAKE_CURRENT_BINARY_DIR}/wwwdocs)

file(GLOB doc_figure_files "doc/**/*.clp")
foreach(doc_figure_path ${doc_figure_files})
get_filename_component(doc_figure_name ${doc_figure_path} NAME_WE)
get_filename_component(doc_figure_srcdir ${doc_figure_path} DIRECTORY)
add_custom_target(
doc_figure_${doc_figure_name}
WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
COMMAND ${CMAKE_CURRENT_BINARY_DIR}/clip ${doc_figure_srcdir}/${doc_figure_name}.clp -e ${doc_figure_srcdir}/${doc_figure_name}.svg)
add_dependencies(doc_figure_${doc_figure_name} clip-cli)
add_dependencies(doc doc_figure_${doc_figure_name})
endforeach()


18 changes: 8 additions & 10 deletions doc/figures/quickstart1.clp
@@ -1,10 +1,8 @@
(layout/margins margin 4em)

(plot/lines
data-x (100 200 300 400 500 600 700 800 900)
data-y (1.2 1.8 1.3 1.6 1.5 1.3 1.8 1.9 2.0)
limit-y (0 3)
limit-x (0 1000)
marker-shape (pentagon)
marker-size 8pt)

(figure/plot
lines (
data-x (100 200 300 400 500 600 700 800 900)
data-y (1.2 1.8 1.3 1.6 1.5 1.3 1.8 1.9 2.0)
limit-y (0 3)
limit-x (0 1000)
marker-shape (pentagon)
marker-size 8pt))
22 changes: 12 additions & 10 deletions doc/figures/quickstart1.svg
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
29 changes: 13 additions & 16 deletions doc/figures/quickstart2.clp
@@ -1,16 +1,13 @@
(layout/margins margin 4em)

(plot/axes
limit-y (0 3)
limit-x (0 1000)
label-format-x (scientific)
label-placement-x (linear-interval 100 100 900))

(plot/lines
data-x (100 200 300 400 500 600 700 800 900)
data-y (1.2 1.8 1.3 1.6 1.5 1.3 1.8 1.9 2.0)
limit-y (0 3)
limit-x (0 1000)
marker-shape (pentagon)
marker-size 8pt)

(figure/plot
axes (
limit-y (0 3)
limit-x (0 1000)
label-format-x (scientific)
label-placement-x (linear-interval 100 100 900))
lines (
data-x (100 200 300 400 500 600 700 800 900)
data-y (1.2 1.8 1.3 1.6 1.5 1.3 1.8 1.9 2.0)
limit-y (0 3)
limit-x (0 1000)
marker-shape (pentagon)
marker-size 8pt))

0 comments on commit 809eea6

Please sign in to comment.