aselimov/pubs
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Minor readme and config update on git plugin.

Browse Source
This commit is contained in:
Olivier Mangin 2019-06-08 09:48:35 -07:00
parent eedd342a2d
commit eaeb48bd20
No known key found for this signature in database
GPG Key ID: D72FEC1C3120A884
2 changed files with 15 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
pubs/config/spec.py
View File

@ -77,7 +77,7 @@ pages = string(default='')
[plugins]
# Comma-separated list of the plugins to load.
# The only current available plugin is alias.
# Currently pubs comes with built-in plugins alias and git.
active = force_list(default=list('alias'))
[[alias]]
@ -99,12 +99,12 @@ active = force_list(default=list('alias'))
# The git plugin will commit changes to the repository in a git repository
# created at the root of the pubs directory. All detected changes will be
# commited every time a change is made by a pubs command.
# The plugin also propose the `pubs git` subcommand, to directory send git
# command to the pubs repository. Therefore, `pubs git status` is equivalent
# The plugin also propose the `pubs git` subcommand, to directly send git
# commands to the pubs repository. Therefore, `pubs git status` is equivalent
# to `git -C <pubsdir> status`, with the `-C` flag instructing
# to invoke git as if the current directory was <pubsdir>. Note that a
# limitation of the subcommand is that you cannot use git commands with the
# `-c` option (pubs will interpret it first.)
# `-c` option (pubs will interpret it first.)
# if False, will display git output when automatic commit are made.
# Invocation of `pubs git` will always have output displayed.

10
readme.md
View File

@ -95,6 +95,16 @@ And open your documents automatically from the command line:
pubs doc open --with lp Loeb_2012 # Opens the document with `lp` to actually print it.
```
## Versioning
Pubs comes with a git plugin that automatically commits your changes. You only need to activate it in your configuration:
```ini
[plugins]
active = git,
```
You can then also conveniently interact with the git repository by using `pubs git <regular git commands>`.
## Customization
Pubs is designed to interact well with your command line tool chain.