Documented DebOps fold format as example and fully support it in yaml2rst. #6
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Ref: debops/docs#156 (comment) One thing that @drybjed changed was to go from ```YAML # Main configuration [[[ # ------------------ ``` to: ```YAML # Main configuration [[[ # ---------------------- ``` This has the advantage that in case we ever manage to get syntax highlighting for the embedded RST syntax working in Vim, it will not complain about sections being to short. I tried it but I am not sure if that is possible as the `# ` in the input for the syntax highlighting in Vim would need to be stipped out and then passed to the `rst` syntax highlighting. Ref: http://vim.wikia.com/wiki/Different_syntax_highlighting_within_regions_of_a_file#Extended_version
…roject. Related to: debops/docs#156
`--strip-regex` was intentionally limited to the RST part of the input to avoid problems. `--yaml-strip-regex` allows to mess with the YAML part of the input if needed. Related to: debops#3 Related to: debops/docs#156
ypid
added a commit
to ypid/docs-1
that referenced
this pull request
Jul 12, 2016
ypid
added a commit
to ypid/docs-1
that referenced
this pull request
Jul 12, 2016
| @@ -53,7 +53,9 @@ dist: | |||
| examples: PYTHONPATH = . | |||
| examples: | |||
| PYTHONPATH=. | |||
| bin/yaml2rst examples/main.yml examples/main.rst --strip-regex '\s*(:?\[{3}|\]{3})\d?$$' | |||
| sed --regexp-extended 's/(\.\. )envvar(::)/\1note\2/;' examples/fold-markers-debops.yml examples/main.yml \ | |||
| | bin/yaml2rst - examples/main.rst --strip-regex '\s*(:?\[{3}|\]{3})\d?$$' --yaml-strip-regex '^\s{66,67}#\s\]{3}\d?$$' | |||
There was a problem hiding this comment.
Huh, This is very hard to read. I suggest using an intermediate target (is it examples/main.yml?)
There was a problem hiding this comment.
Good idea. Done. You might need to use make examples -B now as make does not check all the dependencies of yaml2rst (e. g. when you make a change in the Python module).
|
Thanks for the quick reaction. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
@htgoebel Good thing that you waited with the release. There was another extention needed because of a little redesign.
Docs: https://github.com/ypid/yaml2rst/blob/feature/yaml-fold-strip/docs/fold-markers.rst
Related to: #3
Related to: debops/docs#156