debian-packages/dyaml
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

More doc generation fixes.

Browse source
This commit is contained in:
Ferdinand Majerech 2013-12-17 15:06:20 +01:00
parent 7ac83245a4
commit 1c017c6492
3 changed files with 7 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
autoddoc.cfg
View file

@ -7,12 +7,12 @@ version = 0.4
copyright = Ferdinand Majerech 2011. Based on <a href="http://www.pyyaml.org">PyYAML</a> by Kirill Simonov. copyright = Ferdinand Majerech 2011. Based on <a href="http://www.pyyaml.org">PyYAML</a> by Kirill Simonov.
# File name of the logo of the project, if any. # File name of the logo of the project, if any.
# Should be a PNG image. E.g. "logo.png". # Should be a PNG image. E.g. "logo.png".
logo = docsrc/logo128.png logo = ../docsrc/logo128.png
[OUTPUT] [OUTPUT]
# Directory to write the documentation to. # Directory to write the documentation to.
# If none specified, "autoddoc" is used. # If none specified, "autoddoc" is used.
directory = doc/html/api directory = ../doc/html/api
# CSS style to use. If empty, default will be generated. # CSS style to use. If empty, default will be generated.
# You can create a custom style by generating default style # You can create a custom style by generating default style
# with "autoddoc.py -s" and modyfing it. # with "autoddoc.py -s" and modyfing it.
@ -20,7 +20,7 @@ style =
# Documentation index file to use. If empty, default will be generated. # Documentation index file to use. If empty, default will be generated.
# You can create a custom index by generating default index # You can create a custom index by generating default index
# with "autoddoc.py -i" and modyfing it. # with "autoddoc.py -i" and modyfing it.
index = docsrc/autoddoc_index.dd index = ../docsrc/autoddoc_index.dd
# Any extra links to add to the sidebar of the documentation. # Any extra links to add to the sidebar of the documentation.
# Should be in the format "LINK DESCRIPTION", separated by commas. # Should be in the format "LINK DESCRIPTION", separated by commas.
# E.g; To add links to Google and the D language site, you would use: # E.g; To add links to Google and the D language site, you would use:
@ -34,4 +34,4 @@ ignore = test/*, examples/*, docsrc/*, autoddoc/*, yaml.d, unittest.d, cdc.d, dy
[DDOC] [DDOC]
# Command to use to generate the documentation. # Command to use to generate the documentation.
# Can be modified e.g. to use GDC or LDC. # Can be modified e.g. to use GDC or LDC.
ddoc_command = dmd -d -c -o- -Isource ddoc_command = dmd -d -c -o-

4
autoddoc.py
View file

@ -499,7 +499,7 @@ def add_index(index, output_dir):
return return
shutil.copy(index, index_path) shutil.copy(index, index_path)
def generate_ddoc(sources, output_dir, ddoc_template, ddoc_command): def generate_ddoc(sources, output_dir, ddoc_command):
"""Generate documentation from sources, writing it to output_dir.""" """Generate documentation from sources, writing it to output_dir."""
#Generate index html with ddoc. #Generate index html with ddoc.
@ -647,7 +647,7 @@ def main():
add_css(css, output_dir) add_css(css, output_dir)
add_index(index, output_dir) add_index(index, output_dir)
generate_ddoc(sources, output_dir, ddoc_template, ddoc_line + " " + ddoc_template); generate_ddoc(sources, output_dir, ddoc_line + " " + ddoc_template)
os.remove(ddoc_template) os.remove(ddoc_template)
except Exception as error: except Exception as error:
print("Error during documentation generation:", error) print("Error during documentation generation:", error)

2
docsrc/Makefile
View file

@ -40,7 +40,7 @@ clean:
# DDOC GENERATION CODE # DDOC GENERATION CODE
################################################################################ ################################################################################
ddoc_html : ddoc_html :
cd ../ && ./autoddoc.py cd ../source && ../autoddoc.py ../autoddoc.cfg
################################################################################ ################################################################################
# DDOC GENERATION CODE END # DDOC GENERATION CODE END
################################################################################ ################################################################################