theablefew / stretchy

Elasticsearch Models for Rails with an ActiveRecord-like behavior
https://theablefew.github.io/stretchy/#/
MIT License
2 stars 0 forks source link

Build documentation #38

Open esmarkowski opened 4 months ago

esmarkowski commented 4 months ago

I've switched from yardoc, to tomdoc, back to rdoc. I'm kinda disappointed in the output options after all these years.

I'm going to use docsify to host docs on gh-pages branch.

I want the build process to be automated.

Docs should include:

esmarkowski commented 4 months ago

build_docs GitHub action

on: :pull_request 

  build_docs > 
    checkout gh_pages
    run rdoc > docs/doc
    insert _sidebar.md in docs/doc?
esmarkowski commented 3 months ago

Generates RDoc markdown and creates _sidebar.md for each directory tree.

Need to update template instead of using rdoc-markdown because it's goofy.

rake documentation:generate
rake documentation:build_sidebar