"Scenarios" chapter renamed to "Use cases"

This commit is contained in:
Mateusz Pusz
2020-03-19 14:45:59 +01:00
parent 034f239f96
commit 5d06b66316
9 changed files with 33 additions and 29 deletions

View File

@@ -63,6 +63,10 @@ add_custom_command(OUTPUT "${SPHINX_INDEX_FILE}"
WORKING_DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}"
DEPENDS
"${CMAKE_CURRENT_SOURCE_DIR}/_static/css/custom.css"
"${CMAKE_CURRENT_SOURCE_DIR}/_static/img/concepts.png"
"${CMAKE_CURRENT_SOURCE_DIR}/_static/img/downcast_1.png"
"${CMAKE_CURRENT_SOURCE_DIR}/_static/img/downcast_2.png"
"${CMAKE_CURRENT_SOURCE_DIR}/_static/img/units.png"
"${CMAKE_CURRENT_SOURCE_DIR}/CHANGELOG.md"
"${CMAKE_CURRENT_SOURCE_DIR}/design.rst"
"${CMAKE_CURRENT_SOURCE_DIR}/design/directories.rst"
@@ -88,11 +92,11 @@ add_custom_command(OUTPUT "${SPHINX_INDEX_FILE}"
"${CMAKE_CURRENT_SOURCE_DIR}/reference/functions.rst"
"${CMAKE_CURRENT_SOURCE_DIR}/reference/systems.rst"
"${CMAKE_CURRENT_SOURCE_DIR}/reference/types.rst"
"${CMAKE_CURRENT_SOURCE_DIR}/scenarios.rst"
"${CMAKE_CURRENT_SOURCE_DIR}/scenarios/custom_representation_types.rst"
"${CMAKE_CURRENT_SOURCE_DIR}/scenarios/extensions.rst"
"${CMAKE_CURRENT_SOURCE_DIR}/scenarios/legacy_interfaces.rst"
"${CMAKE_CURRENT_SOURCE_DIR}/scenarios/unknown_units_and_dimensions.rst"
"${CMAKE_CURRENT_SOURCE_DIR}/use_cases.rst"
"${CMAKE_CURRENT_SOURCE_DIR}/use_cases/custom_representation_types.rst"
"${CMAKE_CURRENT_SOURCE_DIR}/use_cases/extensions.rst"
"${CMAKE_CURRENT_SOURCE_DIR}/use_cases/legacy_interfaces.rst"
"${CMAKE_CURRENT_SOURCE_DIR}/use_cases/unknown_units_and_dimensions.rst"
"${CMAKE_CURRENT_SOURCE_DIR}/usage.rst"
"${DOXYGEN_INDEX_FILE}"
MAIN_DEPENDENCY "${SPHINX_SOURCE}/conf.py"

View File

@@ -26,7 +26,7 @@ with a permissive `MIT license <https://github.com/mpusz/units/blob/master/LICEN
quick_start
usage
framework
scenarios
use_cases
design
examples
faq

View File

@@ -1,16 +0,0 @@
Scenarios
=========
.. note::
For brevity all the code examples in this chapter assume::
using namespace units;
.. toctree::
:maxdepth: 2
scenarios/unknown_units_and_dimensions
scenarios/legacy_interfaces
scenarios/custom_representation_types
scenarios/extensions

View File

@@ -1,7 +0,0 @@
.. namespace:: units
Custom Representation Type
==========================
Customization points
--------------------

16
docs/use_cases.rst Normal file
View File

@@ -0,0 +1,16 @@
Use Cases
=========
.. note::
For brevity all the code examples in this chapter assume::
using namespace units;
.. toctree::
:maxdepth: 2
use_cases/unknown_units_and_dimensions
use_cases/legacy_interfaces
use_cases/custom_representation_types
use_cases/extensions

View File

@@ -0,0 +1,7 @@
.. namespace:: units
Using Custom Representation Types
=================================
Customization points
--------------------