|
|
Mads Kiilerich
|
4d04ac08fff7
|
8 years ago
|
|
docs: fix some sphinx warnings
RST code blocks must have valid syntax, and <someprefix> could thus not be used as placeholder.
|
|
|
Karl Goetz
|
c5512c9d2118
|
8 years ago
|
|
docs/vcs_support: add information on importing repositories
This change directly relates to issue #254.
Some rework of the original patch done by Thomas De Schampheleire: - generalize to cover both Mercurial and Git - simplify instructions for importing via filesystem: don't impose a certain flow as it depends on different factors: are the repos already present on the machine, are they organized in a flat hierarchy or already in a more complex one, ... - invalidating cache while rescanning should not be needed when adding new repositories
|
|
|
Mads Kiilerich
|
2c3d30095d5e
|
9 years ago
|
|
gearbox: replace paster with something TurboGears2-ish that still works with the Pylons stack
This is a step towards moving away from the Pylons stack to TurboGears2, but still independent of it.
Some notes from the porting - it could perhaps be the missing(?) documentation for migrating from paster to gearbox:
Note: 'gearbox' without parameters will crash - specify '-h' to get started testing.
Replace paster summary = 'yada yada' with the first line of the docstring of the Command class ... or override get_description.
Note: All newlines in the docstring will be collapsed and mangle the long help text.
Grouping of commands is not possible. Standard commands (for development) can't be customized under the same name or hidden. (Like for paster, the conceptual model also assumes that the sub-command naming is namespaced so commands from other packages won't conflict.)
The usage help is fully automated from the declared options.
For all deprecated Commands, replace paster hidden = True with gearbox deprecated = True
Note: config_file, takes_config_file, min_args and max_args are not available / relevant.
The gearbox parser is customized by overriding get_parser - there is nothing like paster update_parser.
Gearbox is using argparse instead of optparse ... but argparse add_argument is mostly backwards compatible with optparse add_option.
Instead of overriding command or run as in paster, override take_action in gearbox. The parsed arguments are passed to take_action, not available on the command instance.
Paster BadCommand is not available and must be handled manually, terminating with sys.exit(1).
There is no standard make-config command in gearbox.
Paster appinstall has been replaced by the somewhat different setup_app module in gearbox. There is still no clean way to pass parameters to SetupAppCommand and it relies on websetup and other apparently unnecessary complexity. Instead, implement setup-db from scratch.
Minor change by Thomas De Schampheleire: add gearbox logging configuration. Because we use logging.config.fileConfig(.inifile) during gearbox command execution, the logging settings need to be correct and contain a block for gearbox logging itself. Otherwise, errors in command processing are not even visible and the command exits silently.
|
|
|
Mads Kiilerich
|
ed2fb6e84a02
|
10 years ago
|
|
|
|
|
Mads Kiilerich
|
8867673c8192
|
10 years ago
|
|
|
|
|
Mads Kiilerich
|
fbbe80e3322b
|
10 years ago
|
|
docs: consistent spacing around headings
Start out with 2 empty lines before/after for top level, decrease for deeper levels.
|
|
|
Mads Kiilerich
|
36a35394b3cb
|
10 years ago
|
|
|
|
|
Thomas De Schampheleire
|
b52a1ccee927
|
11 years ago
|
|
|
|
|
Thomas De Schampheleire
|
9cef5a168b88
|
11 years ago
|
|
docs/usage: move Mercurial subrepository info to VCS support page
This commit moves the information verbatim, text changes will be done in a subsequent commit.
|
|
|
Thomas De Schampheleire
|
601282d36c06
|
11 years ago
|
|
docs/usage: generalize 'git support' into 'version control systems support'
Rename and rework the 'git support' page such that it can hold information about Mercurial as well.
|