Skip to content
No description, website, or topics provided.
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
helpers
modules
test
.gitignore
.travis.yml
README.md
config.py
main.py
requirements.txt
template.xml

README.md

Pelican

Author: Bobby Yang

General

This program is used to parse documents from source code files and write output content into a MarkDown format file

Master Build Status: Build Status

Dev Build Status: Build Status

Requirements

  • Python version >= 3.4 with standard libraries installed

How to use

Instructions for how to use this program can be found via its help document by running this command (assuming that we are in the main folder of the program, '$' sign is stating a command line prompt):

$ ./pelican help

The above command will show:

USAGE:
    pelican [PARAMS]

HELP:
    pelican help

PARAMS:
    --xmlfile <value>   Specify path to XML file
    --outfile <value>   Specify path for writing output file
    --anyext            Whether to scan all files with all extensions
    --lang <value>      Specify the language using or let program detect automatically
    --dir <value>       Directory which is used as working directory

If the PARAMS is not using, program will use default settings from the config file.

Currently working on compiling into a standalone executable.

Examples

Run command, write output file to an absolute path at /home/user/OUTPUT.md, working directory, input XML file are getting from default settings, programming language will be detected automatically:

$ ./pelican --outfile /home/user/OUTPUT.md

XML file named readme.xml and output file named README.md will be got from the default working directory setting in config file

$ ./pelican --outfile README.md --xmlfile readme.xml

Working directory is being specified at /home/user/project, XML file readme.xml and output file README.md will be got from the specified working directory also:

$ ./pelican --outfile README.md --xmlfile readme.xml --dir /home/user/project

Specify using Python as language parser by param --lang python, and instruct the parser to scan all files without caring their extensions by param --anyext (these two can be used individually). Any other options will be loaded as default settings from config file:

$ ./pelican --lang python --anyext

Supported languages

  • Python
  • JavaScript (Not implemented)
  • C (Not implemented)
You can’t perform that action at this time.