Class: RailsAutodoc::Generators::InstallGenerator

Inherits:
Rails::Generators::Base
  • Object
show all
Defined in:
lib/generators/rails_autodoc/install_generator.rb

Instance Method Summary collapse

Instance Method Details

#create_ci_workflowObject



29
30
31
# File 'lib/generators/rails_autodoc/install_generator.rb', line 29

def create_ci_workflow
  template "autodoc-verify.yml", ".github/workflows/autodoc-verify.yml"
end

#create_initializerObject



12
13
14
# File 'lib/generators/rails_autodoc/install_generator.rb', line 12

def create_initializer
  template "initializer.rb", "config/initializers/rails_autodoc.rb"
end

#create_output_directoryObject



16
17
18
19
# File 'lib/generators/rails_autodoc/install_generator.rb', line 16

def create_output_directory
  empty_directory "openapi"
  create_file "openapi/.keep"
end

#mount_engineObject



21
22
23
24
25
26
27
# File 'lib/generators/rails_autodoc/install_generator.rb', line 21

def mount_engine
  route <<~ROUTE

    # Auto-generated API documentation (development/staging recommended)
    mount RailsAutodoc::Engine => "/api-docs"
  ROUTE
end