Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Implement "proof-of-concept" rst2rst command #1

Closed
benoitbryon opened this issue Jun 11, 2012 · 1 comment
Closed

Implement "proof-of-concept" rst2rst command #1

benoitbryon opened this issue Jun 11, 2012 · 1 comment
Assignees

Comments

@benoitbryon
Copy link
Owner

See original feature request at benoitbryon/documentation-style-guide-sphinx#8

Proof of concept implementation could be:

Feature: script which transforms RST files to RST
  In order to apply style guide conventions on existing RST files
  As a documentation writer
  I want to run a script which does most of the work automatically

  Scenario: apply style guide recommendations on an existing RST file
    Given a file named `example.txt`
    And this file contains valid RST content
    And the title of the document doesn't use `#` (sharp) character with overline
    And other titles don't use `#` (sharp) character
    When I run `rst2rst` script with `example.txt` as argument
    Then the RST content is displayed on the standard output
    And the title of the document uses  `#` (sharp) character with overline.
@benoitbryon
Copy link
Owner Author

Done. The implementation is really naive right now... but should be enough for a proof of concept.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant