Textile documentation generator #83

jonathanpa · 2013-08-21T07:20:59Z

Hi,

I've added writers, templates, etc. to generate the documentation in textile. I noticed that you have pushed some new commits on your master branch since I forked your repo. I wanted to merge your changes into my repo and then send you a pull request, however I saw that running rspecgenerates warnings and running cucumberfails. I guess you haven't finished what you wanted to do yet and I gave up the merge.

Additionally, I will do some tests of the textile docs generation with real projects. If the tests are ok, I'll merge my develop branch into my master branch.

to prepare Textile and Markdown writers.

Views.

of HtmlIndex and HtmlExample.

Textile Index Cucumber Feature and Steps.

pages.

example.

with new api.

textile_documentation feature.

textile for new test api.

to test presence of generated examples.

oestrich · 2013-08-21T13:15:21Z

I have this merged in and passing locally. The only thing that was failing was the docs dir changed so the textile feature needed updating.

I like what you did with the Views. My only concern is that the textile index doesn't link to examples, it just has the description.

…ges_from_zipmark Conflicts: spec/api_documentation_spec.rb

DSL and path generation changes.

jonathanpa · 2013-08-30T10:03:17Z

I pushed new commits.

I merged your latest changes to my branch. For the problems I had with rspec and cucumber, there was a conflict between your version of rake(0.9.2.2) and mine in my default gemset (10.0.3). Using bundle exec solves all.
I fixed a bug in the markup_index.rb(commit 5cd4d3a) that was using HtmlExample in the examples method.
I added the links to examples in the textile index.

Textile documentation generator

Jonathan Pares and others added 20 commits July 4, 2013 17:04

Ignore swp files.

fecf23b

Generate api docs in json, combined_text and html.

842a975

Added a GeneralMarkupWriter class as parent of HtmlWriter

397bd37

to prepare Textile and Markdown writers.

Moved HtmlIndex and HtmlExample to a dedicated module

c789f44

Views.

Added MarkupIndex and MarkupExample for views as parent

6174372

of HtmlIndex and HtmlExample.

Merge branch 'feature/writers_minor_refactoring' into develop

58b26a3

Added textile views and writer.

1a74b2a

Textile Index and Example mustache templates with

a3780d1

Textile Index Cucumber Feature and Steps.

Added additional test cases in textile_documentation.feature.

c03d6c8

Remove links in textile index towards textile examples

3a717fc

pages.

First version of the textile_example mustache template.

c16e673

Cucumber steps definitions written for basic textile

1800a64

example.

Use Sinatra dummy app for textile_documentation.feature.

47502e4

Rewrote the spec dummy api and its related api spec.

e5defdb

In textile_documentation.feature, contents retested

1e9ed3f

with new api.

Check contents of 'Creating an order' example file in

3904c77

textile_documentation feature.

Added scenarios to test presence of generated examples

ae1eeb9

textile for new test api.

Corrections on scenarios in textile_documentation.feature

1a99d05

to test presence of generated examples.

Added TextileWriter test cases in api_documentation_spec.rb.

6553294

Merge branch 'feature/textile_writter' into develop

1f05639

jonathanpa added 6 commits August 30, 2013 10:08

Merge remote-tracking branch 'zipmark/master' into feature/merge_chan…

a205f57

…ges_from_zipmark Conflicts: spec/api_documentation_spec.rb

Updated textile_documentation.feature with the latest

4869063

DSL and path generation changes.

Merge branch 'feature/merge_changes_from_zipmark' into develop

7306126

Fix in MarkupIndex that should not use HtmlExample.

5cd4d3a

Added links to textile examples in textile index.

c8819f6

Merge branch 'feature/links_into_textile_index_to_examples' into develop

637e143

oestrich added a commit that referenced this pull request Aug 30, 2013

Merge pull request #83 from jonathanpa/develop

9a5c79e

Textile documentation generator

oestrich merged commit 9a5c79e into zipmark:master Aug 30, 2013

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Textile documentation generator #83

Textile documentation generator #83

Uh oh!

jonathanpa commented Aug 21, 2013

Uh oh!

oestrich commented Aug 21, 2013

Uh oh!

jonathanpa commented Aug 30, 2013

Uh oh!

Uh oh!

Textile documentation generator #83

Textile documentation generator #83

Uh oh!

Conversation

jonathanpa commented Aug 21, 2013

Uh oh!

oestrich commented Aug 21, 2013

Uh oh!

jonathanpa commented Aug 30, 2013

Uh oh!

Uh oh!