rewrite/cleanup for documentation builder #277
Conversation
|
|
||
| logger = fancylogger.getLogger() | ||
|
|
||
| REPOMAP = { |
There was a problem hiding this comment.
hmmmm. either move this to a config file (ini-style) or better yet, add a .docbuilder.cfg in each repo with whatever data you need. then you only need to a list of repos here (or query all repos like this PR in release helper quattor/release-helper#1).
There was a problem hiding this comment.
good idea, I'll give that a go!
|
|
||
| import os | ||
| import sys | ||
| import jinja2 |
There was a problem hiding this comment.
I know it exists for python but it's own wesbite says it is not intended for production use yet. (version 0.1.post1 with no updates since 2015 on pypi). The server where the code should be is down (http://template-toolkit.org/svnweb/Template-Python)
So I opted for jinja2 which is very very similar and is widely used and maintained.
Unless I'm missing something off course.
There was a problem hiding this comment.
There was a problem hiding this comment.
ok, I'll rework that.
|
|
||
| logger = fancylogger.getLogger() | ||
|
|
||
| MAILREGEX = re.compile(("([a-z0-9!#$%&'*+\/=?^_`{|}~-]+(?:\.[a-z0-9!#$%&'*+\/=?^_`" |
| if email[0].startswith('//'): | ||
| replace = False | ||
| for ignoremail in EXAMPLEMAILS: | ||
| if ignoremail in email[0]: |
| setup( | ||
| name = 'documentation-builder', | ||
| description = 'Documentation Builder for Quattor', | ||
| url='https://github.com/wdpypere/release/tree/doc_builder_2.0/src/documentation_builder', |
| """Check if a repository mapping is valid.""" | ||
| logger.info("Checking repository map.") | ||
| if repository_map is None: | ||
| logger.error("Repository map is empty.") |
There was a problem hiding this comment.
Distinguish between the two possible error states so the person reading the error logs knows which case was hit: None or []
implement interlinks
| """Run several cleaners on the content we get from perl files.""" | ||
| for source, content in markdown.iteritems(): | ||
| if not source.endswith('.pan'): | ||
| if cleanup_options['remove_emails']: |
There was a problem hiding this comment.
if the functions and keys match, you can do
for fn in [...]:
if cleanup_options[fn]:
content = globals()[fn](content)
add maven_tools and config files
|
@stdweird all remarks adressed, this now works with a |
Refactored
quattorpoddoc.pyscript.Mainly:
This should make the whole thing more readable, maintainable.
Also, this makes it easier to replicate to another build system or run your local copy. The following commands should be enough to build the docs (requires that you can build components on the system).
fixes #256
As per usual, remarks are very welcome!