Module: Docs

Defined in:

lib/docs/engine.rb,
app/models/docs/page.rb,
lib/api_docs_engine/docs.rb,
app/models/docs/page_category.rb,
app/models/docs/routes_collection.rb,
app/models/docs/missing_collection.rb,
app/helpers/docs/application_helper.rb,
app/controllers/docs/pages_controller.rb,
app/controllers/docs/markdown_controller.rb,
app/controllers/docs/application_controller.rb,
app/controllers/docs/missing_docs_controller.rb,
app/controllers/concerns/docs/manage_resource.rb,
app/controllers/docs/page_categories_controller.rb

Defined Under Namespace

Modules: ApplicationHelper, ManageResource Classes: ApplicationController, Engine, MarkdownController, MissingCollection, MissingDocsController, Page, PageCategoriesController, PageCategory, PagesController, RoutesCollection

Constant Summary

@@title =

"API documentation"

@@root_path =

"missing_docs#index"

@@missing_routes_filter =

/api\/.*/

@@api_docs_prefix =

"api"

@@auth =

nil

Class Method Summary

• .route(router) ⇒ Object
• .setup {|_self| ... } ⇒ Object

Class Method Details

.route(router) ⇒ Object

# File 'lib/api_docs_engine/docs.rb', line 34

def route(router)
  router.instance_exec do
    root Docs.root_path
    
    resources :missing_docs,    only: [:index]    
    resources :page_categories, except: [:index, :show, :edit]
    resources :pages,           except: [:index, :show]
    
    resources :page_categories, shallow: true, path: Docs.api_docs_prefix, only: [:edit] do
      resources :pages, only: [:index, :new, :create], path: "", path_names: { new: "new_page" }
    end
    
    resources :markdown, only: "create"
  end
end

.setup {|_self| ... } ⇒ Object

Yields:

• (_self)

Yield Parameters:

• _self (Docs) —

  the object that the method was called on

# File 'lib/api_docs_engine/docs.rb', line 30

def setup
  yield self
end