diff options
author | Ben Gamari <ben@smart-cactus.org> | 2019-10-04 14:25:26 -0400 |
---|---|---|
committer | Marge Bot <ben+marge-bot@smart-cactus.org> | 2019-10-08 05:12:58 -0400 |
commit | a95f7185d38c2b49ef50698211447e47b5be1558 (patch) | |
tree | ef63189c798b6cc2350f46cde8278f5f586a9925 /docs | |
parent | 98c094227c7738a65dfc5908b3397d7275e56ea1 (diff) | |
download | haskell-a95f7185d38c2b49ef50698211447e47b5be1558.tar.gz |
doc: Write out documented flag list
Diffstat (limited to 'docs')
-rw-r--r-- | docs/users_guide/flags.py | 12 |
1 files changed, 11 insertions, 1 deletions
diff --git a/docs/users_guide/flags.py b/docs/users_guide/flags.py index ac5de4cb57..90d6921827 100644 --- a/docs/users_guide/flags.py +++ b/docs/users_guide/flags.py @@ -53,6 +53,8 @@ from sphinx.errors import SphinxError from distutils.version import LooseVersion from utils import build_table_from_list +import os.path + ### Settings # Categories to titles as well as a canonical list of categories @@ -590,15 +592,23 @@ class ExtensionPrintDirective(Directive): ### Additional processing -# Convert every flagprint node into its output format def process_print_nodes(app, doctree, fromdocname): + # Convert every flagprint node into its output format for node in doctree.traverse(flagprint): node.generate_output(app, fromdocname) for node in doctree.traverse(extensionprint): node.generate_output(app, fromdocname) + # Write out file listing all documented flags + with open(os.path.join(app.outdir, 'ghc-flags.txt'), 'w') as f: + flag_names = \ + {name + for flag in app.env.all_flags + for name in flag['names']} + + f.write('\n'.join(flag_names)) # To avoid creating duplicates in the serialized environment, clear all # flags originating from a file before re-reading it. |