[go: up one dir, main page]
Menu ▾ ▴

[172b15]: / makedoc.py  Maximize  Restore  History

Download this file

84 lines (74 with data), 3.1 kB 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
# -*- coding: UTF-8 -*-

# makedoc.py

# Summary: Create the documentation of WhakerKit, using ClammingPy 1.7+ library.

# Usage: python makedoc.py

#

# This file is part of WhakerKit tool.

# Copyright (C) 2024-2025 Brigitte Bigi, CNRS

# Laboratoire Parole et Langage, Aix-en-Provence, France.

#

# Use of this software is governed by the GNU Affero Public License, version 3.

#

# WhakerKit is free software: you can redistribute it and/or modify

# it under the terms of the GNU Affero General Public License as published by

# the Free Software Foundation, either version 3 of the License, or

# (at your option) any later version.

#

# WhakerKit is distributed in the hope that it will be useful,

# but WITHOUT ANY WARRANTY; without even the implied warranty of

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

# GNU Affero General Public License for more details.

#

# You should have received a copy of the GNU Affero General Public License

# along with WhakerKit. If not, see <https://www.gnu.org/licenses/>.

#

# This banner notice must not be removed.

#

# ---------------------------------------------------------------------------



import sys

import logging



import whakerkit

try:

    import clamming

except ImportError:

    print("This program requires `ClammingPy` documentation generator.")

    print("It can be installed with: pip install ClammingPy.")

    print("See <https://clamming.sourceforge.io/> for details.")

    sys.exit(-1)



# ---------------------------------------------------------------------------

logging.getLogger().setLevel(0)



# List of modules to be documented.

packages = list()

packages.append(whakerkit.config)

packages.append(whakerkit.components)

packages.append(whakerkit.connection)

packages.append(whakerkit.documents)

packages.append(whakerkit.filters)

packages.append(whakerkit.error)

packages.append(whakerkit.nodes)

packages.append(whakerkit.responses)



# Options for HTML exportation

opts_export = clamming.ExportOptions()

opts_export.software = 'WhakerKit ' + whakerkit.__version__

opts_export.url = 'https://sourceforge.net/projects/whakerkit/'

opts_export.copyright = whakerkit.__copyright__

opts_export.title = 'WhakerKit doc'

# ... statics is the relative path to a folder with custom CSS, JS, etc.

opts_export.statics = './statics'

# ... the favicon and icon are files in the statics folder

opts_export.favicon = 'favicon.ico'

opts_export.icon = 'whakerkit.png'

# ... the theme corresponds to a statics/<theme>.css file or "light" or "dark"

opts_export.theme = 'light'

# ... path to 'wexa_statics' folder, relatively to "docs"

opts_export.wexa_statics = "../whakerexa/wexa_statics"





# -------------------------------------------------

# Generate documentation

# -------------------------------------------------

clams_modules = clamming.ClamsModules(packages)



# Export documentation into HTML files.

# One .html file = one documented class.

clams_modules.html_export_packages("docs", opts_export, "README.md")



# Export documentation into a Markdown file.

# One .md file = one documented module.

clams_modules.markdown_export_packages("docs", opts_export)