diff options
author | Alexis Hildebrandt <afh@surryhill.net> | 2023-04-25 11:41:06 +0200 |
---|---|---|
committer | Alexis Hildebrandt <afh@surryhill.net> | 2023-04-25 21:25:54 +0200 |
commit | c38c23dcab5d7e5e389ea5527301017571cfce24 (patch) | |
tree | 0f2447c0be2c231dddf40dd92be4ed07566f5ce6 /src/pyledger.cc | |
parent | 209f6f4a52c923ce8424a0ffcc57cbf0c1a25aea (diff) | |
download | fork-ledger-c38c23dcab5d7e5e389ea5527301017571cfce24.tar.gz fork-ledger-c38c23dcab5d7e5e389ea5527301017571cfce24.tar.bz2 fork-ledger-c38c23dcab5d7e5e389ea5527301017571cfce24.zip |
doc: Generate Ledger Python module documentation
using pydoc when building web docs.
Diffstat (limited to 'src/pyledger.cc')
-rw-r--r-- | src/pyledger.cc | 19 |
1 files changed, 18 insertions, 1 deletions
diff --git a/src/pyledger.cc b/src/pyledger.cc index e4a5d262..a716f1a5 100644 --- a/src/pyledger.cc +++ b/src/pyledger.cc @@ -29,7 +29,7 @@ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ -#include <system.hh> +#include <ledger.hh> #include "pyinterp.h" @@ -43,6 +43,23 @@ BOOST_PYTHON_MODULE(ledger) { using namespace ledger; + scope().attr("__author__") = "John Wiegley <jwiegley@gmail.com>"; + scope().attr("__version__") = Ledger_VERSION; + scope().attr("__date__") = Ledger_VERSION_DATE; + scope().attr("__doc__") = + "Python API Documentation\n\n" + "Documentation of the Ledger Python API is an ongoing process and you are invited\n" + "to help out and contribute. In case you find this documentation incorrect,\n" + "incomplete, unclear, or lacking please open a pull request at\n" + "https://git.ledger-cli.org/ledger/pulls." + ; + +#if !DEBUG_MODE + docstring_options doc_options; + doc_options.disable_cpp_signatures(); +#endif + + if (! python_session.get()) python_session.reset(new python_interpreter_t); |