From cc666c9a93ef4a374109b09f6be47ffa7aaac4b7 Mon Sep 17 00:00:00 2001 From: Aina Niemetz Date: Tue, 1 Jun 2021 17:05:52 -0700 Subject: [PATCH] docs: Restructure index page, fix style issue. (#6657) --- docs/CMakeLists.txt | 7 ++-- docs/_static/custom.css | 41 ++++++++++--------- docs/api/CMakeLists.txt | 22 ++++++++++ docs/api/api.rst | 8 ++++ docs/{ => api}/cpp/CMakeLists.txt | 2 +- docs/{ => api}/cpp/Doxyfile.in | 0 docs/{ => api}/cpp/cpp.rst | 0 docs/{ => api}/cpp/datatype.rst | 0 docs/{ => api}/cpp/datatypeconstructor.rst | 0 .../{ => api}/cpp/datatypeconstructordecl.rst | 0 docs/{ => api}/cpp/datatypedecl.rst | 0 docs/{ => api}/cpp/datatypeselector.rst | 0 docs/{ => api}/cpp/exceptions.rst | 0 docs/{ => api}/cpp/grammar.rst | 0 docs/{ => api}/cpp/kind.rst | 0 docs/{ => api}/cpp/op.rst | 0 docs/{ => api}/cpp/result.rst | 0 docs/{ => api}/cpp/roundingmode.rst | 0 docs/{ => api}/cpp/solver.rst | 0 docs/{ => api}/cpp/sort.rst | 0 docs/{ => api}/cpp/statistics.rst | 0 docs/{ => api}/cpp/term.rst | 0 docs/{ => api}/python/CMakeLists.txt | 0 docs/{ => api}/python/datatype.rst | 0 docs/{ => api}/python/python.rst | 0 docs/index.rst | 20 +++++---- 26 files changed, 67 insertions(+), 33 deletions(-) create mode 100644 docs/api/CMakeLists.txt create mode 100644 docs/api/api.rst rename docs/{ => api}/cpp/CMakeLists.txt (98%) rename docs/{ => api}/cpp/Doxyfile.in (100%) rename docs/{ => api}/cpp/cpp.rst (100%) rename docs/{ => api}/cpp/datatype.rst (100%) rename docs/{ => api}/cpp/datatypeconstructor.rst (100%) rename docs/{ => api}/cpp/datatypeconstructordecl.rst (100%) rename docs/{ => api}/cpp/datatypedecl.rst (100%) rename docs/{ => api}/cpp/datatypeselector.rst (100%) rename docs/{ => api}/cpp/exceptions.rst (100%) rename docs/{ => api}/cpp/grammar.rst (100%) rename docs/{ => api}/cpp/kind.rst (100%) rename docs/{ => api}/cpp/op.rst (100%) rename docs/{ => api}/cpp/result.rst (100%) rename docs/{ => api}/cpp/roundingmode.rst (100%) rename docs/{ => api}/cpp/solver.rst (100%) rename docs/{ => api}/cpp/sort.rst (100%) rename docs/{ => api}/cpp/statistics.rst (100%) rename docs/{ => api}/cpp/term.rst (100%) rename docs/{ => api}/python/CMakeLists.txt (100%) rename docs/{ => api}/python/datatype.rst (100%) rename docs/{ => api}/python/python.rst (100%) diff --git a/docs/CMakeLists.txt b/docs/CMakeLists.txt index 11c4b8dfd..b20819001 100644 --- a/docs/CMakeLists.txt +++ b/docs/CMakeLists.txt @@ -17,8 +17,7 @@ check_python_module(breathe) check_python_module(sphinxcontrib.bibtex sphinxcontrib-bibtex) check_python_module(sphinx_tabs.tabs sphinx-tabs) -add_subdirectory(cpp) -add_subdirectory(python) +add_subdirectory(api) set(SPHINX_INPUT_DIR ${CMAKE_CURRENT_SOURCE_DIR}) set(SPHINX_OUTPUT_DIR ${CMAKE_CURRENT_BINARY_DIR}/sphinx) @@ -31,8 +30,8 @@ add_custom_target( COMMAND ${SPHINX_EXECUTABLE} -b html -c ${CMAKE_CURRENT_BINARY_DIR} # Tell Breathe where to find the Doxygen output - -Dbreathe_projects.cvc5=${CPP_DOXYGEN_XML_FOLDER} - -Dbreathe_projects.std=${CPP_DOXYGEN_XML_FOLDER} ${SPHINX_INPUT_DIR} + -Dbreathe_projects.cvc5=${CPP_DOXYGEN_XML_DIR} + -Dbreathe_projects.std=${CPP_DOXYGEN_XML_DIR} ${SPHINX_INPUT_DIR} ${SPHINX_OUTPUT_DIR} WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR} COMMENT "Generating Sphinx Api docs" diff --git a/docs/_static/custom.css b/docs/_static/custom.css index 032efba56..23aa6c36d 100644 --- a/docs/_static/custom.css +++ b/docs/_static/custom.css @@ -15,30 +15,10 @@ code.xref { background: unset !important; } -a { - color: #0099e6; -} - -a:visited { - color: #0099e6; -} - -a:hover, a:focus { - color: #739900; -} - .wy-side-nav-search { background-color: #0099e6; } -.wy-side-nav-search > a { - color: #ace600; -} - -.wy-side-nav-search > a:hover, > a:focus, > a:visited { - color: #ace600; -} - .wy-breadcrumbs a { color: #739900; } @@ -67,6 +47,18 @@ a:hover, a:focus { color: #ace600; } +a { + color: #0099e6; +} + +a:visited { + color: #0099e6; +} + +a:hover, a:focus { + color: #739900; +} + .wy-nav-top { color: #ace600; background-color: #0099e6; @@ -75,3 +67,12 @@ a:hover, a:focus { .wy-nav-top a { color: #ace600; } + +.wy-side-nav-search > a { + color: #ace600; +} + +.wy-side-nav-search > a:hover, > a:focus, > a:visited { + color: #ace600; +} + diff --git a/docs/api/CMakeLists.txt b/docs/api/CMakeLists.txt new file mode 100644 index 000000000..3ade7b5b2 --- /dev/null +++ b/docs/api/CMakeLists.txt @@ -0,0 +1,22 @@ +############################################################################### +# Top contributors (to current version): +# Aina Niemetz +# +# This file is part of the cvc5 project. +# +# Copyright (c) 2009-2021 by the authors listed in the file AUTHORS +# in the top-level source directory and their institutional affiliations. +# All rights reserved. See the file COPYING in the top-level source +# directory for licensing information. +# ############################################################################# +# +# The build system configuration. +# +add_subdirectory(cpp) +add_subdirectory(python) + +# tell parent scope where to find the output xml +set(CPP_DOXYGEN_XML_DIR + "${CPP_DOXYGEN_XML_DIR}" + PARENT_SCOPE +) diff --git a/docs/api/api.rst b/docs/api/api.rst new file mode 100644 index 000000000..34ee0aec7 --- /dev/null +++ b/docs/api/api.rst @@ -0,0 +1,8 @@ +API Documentation +================= + +.. toctree:: + :maxdepth: 1 + + cpp/cpp + python/python diff --git a/docs/cpp/CMakeLists.txt b/docs/api/cpp/CMakeLists.txt similarity index 98% rename from docs/cpp/CMakeLists.txt rename to docs/api/cpp/CMakeLists.txt index de21890dc..f0b153b57 100644 --- a/docs/cpp/CMakeLists.txt +++ b/docs/api/cpp/CMakeLists.txt @@ -42,7 +42,7 @@ add_custom_command( add_custom_target(docs-cpp ALL DEPENDS ${DOXYGEN_INDEX_FILE}) # tell parent scope where to find the output xml -set(CPP_DOXYGEN_XML_FOLDER +set(CPP_DOXYGEN_XML_DIR "${DOXYGEN_OUTPUT_DIR}/xml" PARENT_SCOPE ) diff --git a/docs/cpp/Doxyfile.in b/docs/api/cpp/Doxyfile.in similarity index 100% rename from docs/cpp/Doxyfile.in rename to docs/api/cpp/Doxyfile.in diff --git a/docs/cpp/cpp.rst b/docs/api/cpp/cpp.rst similarity index 100% rename from docs/cpp/cpp.rst rename to docs/api/cpp/cpp.rst diff --git a/docs/cpp/datatype.rst b/docs/api/cpp/datatype.rst similarity index 100% rename from docs/cpp/datatype.rst rename to docs/api/cpp/datatype.rst diff --git a/docs/cpp/datatypeconstructor.rst b/docs/api/cpp/datatypeconstructor.rst similarity index 100% rename from docs/cpp/datatypeconstructor.rst rename to docs/api/cpp/datatypeconstructor.rst diff --git a/docs/cpp/datatypeconstructordecl.rst b/docs/api/cpp/datatypeconstructordecl.rst similarity index 100% rename from docs/cpp/datatypeconstructordecl.rst rename to docs/api/cpp/datatypeconstructordecl.rst diff --git a/docs/cpp/datatypedecl.rst b/docs/api/cpp/datatypedecl.rst similarity index 100% rename from docs/cpp/datatypedecl.rst rename to docs/api/cpp/datatypedecl.rst diff --git a/docs/cpp/datatypeselector.rst b/docs/api/cpp/datatypeselector.rst similarity index 100% rename from docs/cpp/datatypeselector.rst rename to docs/api/cpp/datatypeselector.rst diff --git a/docs/cpp/exceptions.rst b/docs/api/cpp/exceptions.rst similarity index 100% rename from docs/cpp/exceptions.rst rename to docs/api/cpp/exceptions.rst diff --git a/docs/cpp/grammar.rst b/docs/api/cpp/grammar.rst similarity index 100% rename from docs/cpp/grammar.rst rename to docs/api/cpp/grammar.rst diff --git a/docs/cpp/kind.rst b/docs/api/cpp/kind.rst similarity index 100% rename from docs/cpp/kind.rst rename to docs/api/cpp/kind.rst diff --git a/docs/cpp/op.rst b/docs/api/cpp/op.rst similarity index 100% rename from docs/cpp/op.rst rename to docs/api/cpp/op.rst diff --git a/docs/cpp/result.rst b/docs/api/cpp/result.rst similarity index 100% rename from docs/cpp/result.rst rename to docs/api/cpp/result.rst diff --git a/docs/cpp/roundingmode.rst b/docs/api/cpp/roundingmode.rst similarity index 100% rename from docs/cpp/roundingmode.rst rename to docs/api/cpp/roundingmode.rst diff --git a/docs/cpp/solver.rst b/docs/api/cpp/solver.rst similarity index 100% rename from docs/cpp/solver.rst rename to docs/api/cpp/solver.rst diff --git a/docs/cpp/sort.rst b/docs/api/cpp/sort.rst similarity index 100% rename from docs/cpp/sort.rst rename to docs/api/cpp/sort.rst diff --git a/docs/cpp/statistics.rst b/docs/api/cpp/statistics.rst similarity index 100% rename from docs/cpp/statistics.rst rename to docs/api/cpp/statistics.rst diff --git a/docs/cpp/term.rst b/docs/api/cpp/term.rst similarity index 100% rename from docs/cpp/term.rst rename to docs/api/cpp/term.rst diff --git a/docs/python/CMakeLists.txt b/docs/api/python/CMakeLists.txt similarity index 100% rename from docs/python/CMakeLists.txt rename to docs/api/python/CMakeLists.txt diff --git a/docs/python/datatype.rst b/docs/api/python/datatype.rst similarity index 100% rename from docs/python/datatype.rst rename to docs/api/python/datatype.rst diff --git a/docs/python/python.rst b/docs/api/python/python.rst similarity index 100% rename from docs/python/python.rst rename to docs/api/python/python.rst diff --git a/docs/index.rst b/docs/index.rst index fc82111e2..7ab22cd7a 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,18 +1,22 @@ -.. cvc5 documentation master file, created by - sphinx-quickstart on Mon Apr 5 17:02:33 2021. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. +cvc5 Documentation +================== -cvc5 API Documentation -====================== +**cvc5** is an open-source automatic theorem prover for Satisfiability Modulo +Theories (SMT) problems in a large number of theories and their combination. +**cvc5** is the successor of `CVC4 `_ and is +intended to be an open and extensible SMT engine. +This space provides all documentation related to using cvc5. + + +Table of Contents +^^^^^^^^^^^^^^^^^ .. toctree:: :maxdepth: 1 installation/installation binary/binary - cpp/cpp - python/python + api/api examples/examples references genindex -- 2.30.2