pydocmk2.__main__

This is used by the command-line interface.

pydocmk2.__main__

python2 -m pydocmk2 build

Modules

  • argparse
  • atexit
  • json
  • os
  • shutil
  • signal
  • subprocess
  • sys
  • yaml

Classes

class PyDocMk(builtin.object)




Methods 
init(self)







clean_files(self)







copy_source_files(self, pages_required=True)


Copies all files from the `docs_dir` to the `gens_dir` defined in the
*config*. It also takes the MkDocs `pages` configuration into account
and converts the special `<< INFILE` syntax by copying them to the
`gens_dir` as well.





default_config(self, blank=False)







main(self)







makedirs(self, path)


Create the directory *path* if it does not already exist.





new_project(self)







parse_args(self)







process_pages(self, data, gens_dir)







read_config(self)


Reads and preprocesses the pydocmk2 configuration file.





write_temp_mkdocs_config(self)


Generates a configuration for MkDocs on-the-fly from the pydocmk2
configuration and makes sure it gets removed when this program exists.





Descriptors 
dict




dictionary for instance variables (if defined)







weakref




list of weak references to the object (if defined)







  
Functions
log(*args, **kwargs)











PyDocMk


pydocmk2.__main__.PyDocMk = class PyDocMk(__builtin__.object)










Methods 
__init__(self)








clean_files(self)








copy_source_files(self, pages_required=True)



Copies all files from the `docs_dir` to the `gens_dir` defined in the
*config*. It also takes the MkDocs `pages` configuration into account
and converts the special `<< INFILE` syntax by copying them to the
`gens_dir` as well.





default_config(self, blank=False)








main(self)








makedirs(self, path)



Create the directory *path* if it does not already exist.





new_project(self)








parse_args(self)








process_pages(self, data, gens_dir)








read_config(self)



Reads and preprocesses the pydocmk2 configuration file.





write_temp_mkdocs_config(self)



Generates a configuration for MkDocs on-the-fly from the pydocmk2
configuration and makes sure it gets removed when this program exists.





  
Descriptors 
__dict__





dictionary for instance variables (if defined)







__weakref__





list of weak references to the object (if defined)











read_config


pydocmk2.__main__.PyDocMk.read_config = read_config(self) unbound pydocmk2.__main__.PyDocMk method



Reads and preprocesses the pydocmk2 configuration file.








write_temp_mkdocs_config


pydocmk2.__main__.PyDocMk.write_temp_mkdocs_config = write_temp_mkdocs_config(self) unbound pydocmk2.__main__.PyDocMk method



Generates a configuration for MkDocs on-the-fly from the pydocmk2
configuration and makes sure it gets removed when this program exists.








makedirs


pydocmk2.__main__.PyDocMk.makedirs = makedirs(self, path) unbound pydocmk2.__main__.PyDocMk method



Create the directory *path* if it does not already exist.








copy_source_files


pydocmk2.__main__.PyDocMk.copy_source_files = copy_source_files(self, pages_required=True) unbound pydocmk2.__main__.PyDocMk method



Copies all files from the `docs_dir` to the `gens_dir` defined in the
*config*. It also takes the MkDocs `pages` configuration into account
and converts the special `<< INFILE` syntax by copying them to the
`gens_dir` as well.