16 Commits

Author SHA1 Message Date
badisa
d392c755b7 Document Options in RGroupDcompose and other minor docs fixes (#8757)
* Adds missing options docstring

* Always be cleaning

* Fix typos in RGroupDecomposition module

* Update documentation on configuring doxygen

* Was a step that I couldn't find reference to besides in the Makefile

* Undo american spelling of labelling

* British spelling appears more consistent

* Fix style of RGroupDecompositionParameters parameter

* Also fixes a typo

* Remove unintentional use of docstring

* Was assigning documentation about the parameters to the
  RGroupDecomposition

* Remove empty string

* Apply suggestions from code review

Co-authored-by: Greg Landrum <greg.landrum@gmail.com>

---------

Co-authored-by: Greg Landrum <greg.landrum@gmail.com>
2025-09-18 16:41:16 +02:00
Greg Landrum
29ec6fbb69 allow building docs without the C++ docs (#5804)
documentation makefile cleanup
2022-12-16 05:23:59 +01:00
David Cosgrove
6d1266615b Updatecppdocs (#3039)
* Updated CMakeLists.txx

* Updated all examples, extended some.

* Added info about highlighting atoms.

* Added info about annotation to python getting started.

* Minor tweaks.

* Minor tweaks.  Can only examine the rst in GitHub.

* Minor tweaks.  Can only examine the rst in GitHub.

* get doctests working

* update an example image

* Include the GettingStartedInC++ doc in the standard docs build

* move the C++ docs after the python docs

* update backwards incompatible changes doc

Co-authored-by: David Cosgrove <david@cozchemix.co.uk>
Co-authored-by: greg landrum <greg.landrum@gmail.com>
2020-03-27 14:19:17 +01:00
Greg Landrum
76c950171b add a bunch of extension module documentation (#2161) 2018-11-08 12:04:52 -05:00
Greg Landrum
8240aa567f Docs/autodoc update (#2124)
* update the autodoc stuff for the Python docs

* document backwards incompatible changes

* cleanup

* python doc updates
2018-10-19 15:11:56 +02:00
Greg Landrum
b3ddf131a0 Switch Python API documentation generation over to Sphinx autodoc (#1849)
* first pass at something that kind of works

* no need to document sping

* add some imported modules

* forgot to add this before

* switch to using a file per module

* disable the old api copy

* update the way links are handled

* stop auto-running doctests (sigh)
2018-05-16 08:43:59 +02:00
Greg Landrum
cd9994d7b0 Documentation update. (#1100)
* update overview.md

* switch to using the MD docs when possible (works thanks to commonmark and recommonmark);
Fixes #1079

* doc update

* doc update
2016-10-14 11:37:01 -04:00
Greg Landrum
ad4a74b821 get the md version of install working 2015-09-21 17:35:34 +02:00
Greg Landrum
1e1241413d move cookbook to markdown 2015-08-26 11:51:50 +02:00
Greg Landrum
ca4f4a14a9 move the cartridge docs to markdown 2015-08-26 09:16:03 +02:00
Greg Landrum
9cf72408f4 Switch Overview.rst -> Overview.md; update makefile to re-generate Overview.rst 2015-08-17 13:09:53 +02:00
Greg Landrum
783bd1d231 add a bit of docs about building the documentation (relevant to #517) 2015-06-11 04:45:59 -04:00
Greg Landrum
fb1938729d update doxygen files and add new logo without text
Fix #66
2013-07-11 07:19:33 +02:00
Greg Landrum
4ebb12c9ee add direct links to API docs 2012-01-07 15:54:33 +00:00
Greg Landrum
e0482773d8 make sure the python api docs are included 2011-10-08 04:55:09 +00:00
Greg Landrum
261e0d1073 initial pass at switching to using sphinx for the rdkit docs 2011-08-08 17:08:26 +00:00