Skip to content

Commit

Permalink
Doc, fix reference bugs
Browse files Browse the repository at this point in the history
  • Loading branch information
jakobandersen committed Aug 1, 2019
1 parent db41cae commit a4c8807
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 7 deletions.
4 changes: 2 additions & 2 deletions ChangeLog.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Incompatible Changes
- Now requires v0.4 of
`GraphCanon <https://github.com/jakobandersen/graph_canon>`__
(and `PermGroup <https://github.com/jakobandersen/perm_group>`__).
- :cpp:func:`DG::getGraphDatabase` now returns a :cpp:any:`std::vector`
- :cpp:func:`dg::DG::getGraphDatabase` now returns a :cpp:any:`std::vector`
instead of a :cpp:any:`std::unordered_set`.
- Hide internal symbols in the library to increase optimization opportunities,
and hide symbols in library dependencies.
Expand All @@ -29,7 +29,7 @@ New Features

- :py:func:`dgDump`/:cpp:func:`dg::DG::dump` should now be much, much faster
in parsing the input file and loading the contained derivation graph.
- :py:func:`dgRulecomp`/:cpp:func:`dg::DG::ruleComp` should now be much faster
- :py:func:`dgRuleComp`/:cpp:func:`dg::DG::ruleComp` should now be much faster
during calculation.
- Added :py:func:`Graph.instantiateStereo`/:cpp:func:`graph::Graph::instantiateStereo`.
- Added :py:func:`rngReseed`/:cpp:func:`rngReseed`.
Expand Down
2 changes: 1 addition & 1 deletion doc/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ endif()
set(output ${CMAKE_CURRENT_BINARY_DIR}/html)
set(doctrees ${CMAKE_CURRENT_BINARY_DIR}/doctrees)
add_custom_target(mod_doc
COMMAND ${SPHINX} ${CMAKE_CURRENT_SOURCE_DIR}/source -b html ${output} -d ${doctrees})
COMMAND ${SPHINX} ${CMAKE_CURRENT_SOURCE_DIR}/source -n -b html ${output} -d ${doctrees})
if(TARGET doc)
add_dependencies(doc mod_doc)
else()
Expand Down
6 changes: 3 additions & 3 deletions libs/pymod/src/mod/py/Misc.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,9 @@ namespace Py {
// rst: This function is used in all PyMØD functions that takes a filename as argument.
// rst: To circumvent this prefixing use the :py:class:`CWDPath` class.
// rst:
// rst: :returns: :py:attr:`name` prefixed with all strings pushed with :py:func:`pushFilePrefix`
// rst: :returns: `name` prefixed with all strings pushed with :py:func:`pushFilePrefix`
// rst: and popped yet.
// rst: :rtype: str
// rst: :rtype: string
// rst:
// rst: .. function:: pushFilePrefix(s)
// rst:
Expand All @@ -33,7 +33,7 @@ namespace Py {
// rst: If the argument starts with ``/``, then during concatenation all previously pushed prefixes are ignored.
// rst:
// rst: :param s: the string to push as a prefix to be concatenated in :py:func:`prefixFilename`.
// rst: :type s: str
// rst: :type s: string
// rst:
// rst: .. function:: popFilePrefix()
// rst:
Expand Down
2 changes: 1 addition & 1 deletion libs/pymod/src/mod/py/graph/Graph.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -259,7 +259,7 @@ void Graph_doExport() {
// rst: :type: int
.add_property("minExternalId", &Graph::getMinExternalId)
.add_property("maxExternalId", &Graph::getMaxExternalId)
// rst: .. py:method: instantiateStereo()
// rst: .. py:method:: instantiateStereo()
// rst:
// rst: Make sure that stereo data is instantiated.
// rst:
Expand Down

0 comments on commit a4c8807

Please sign in to comment.