Skip to content

Commit

Permalink
Merge pull request #197 from zzak/sdoc-196
Browse files Browse the repository at this point in the history
Remove sdoc-merge and sdoc template
  • Loading branch information
zzak authored Mar 6, 2023
2 parents 68ae568 + ced9241 commit 9a66648
Show file tree
Hide file tree
Showing 26 changed files with 5 additions and 2,082 deletions.
36 changes: 3 additions & 33 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,6 @@

SDoc is an HTML template built on top of the RDoc documentation generator for Ruby code.

Provided are two command-line tools you get when you installing the gem:

* `sdoc` - command line tool to run rdoc with `generator=shtml` (searchable HTML)
* `sdoc-merge` - command line tool to merge multiple sdoc folders into a single documentation site

### Getting Started

```bash
Expand All @@ -35,23 +30,6 @@ Example:
sdoc -o doc/rails -T direct rails
```

### sdoc-merge

`sdoc-merge` is useful tool for combining multiple projects documentation into one HTML website. See `sdoc-merge --help` for more details.

```
Usage: sdoc-merge [options] directories
-n, --names [NAMES] Names of merged repositories. Comma separated
-o, --op [DIRECTORY] Set the output directory
-t, --title [TITLE] Set the title of merged file
```

Example:

```bash
sdoc-merge --title "Ruby v1.9, Rails v2.3.2.1" --op merged --names "Ruby,Rails" ruby-v1.9 rails-v2.3.2.1
```

### Rake Task

If you want, you can setup a task in your `Rakefile` for generating your project's documentation via the `rake rdoc` command.
Expand Down Expand Up @@ -82,13 +60,10 @@ If you notice any bugs in the output of your documentation, it may be RDoc's fau

An example of an SDoc bug would be:

* Exception is raised when merging project documentation (ala `sdoc-merge`)
* Error or warning in JavaScript or HTML found in your browser
* Generation fails with some exception (likely due to incompatibility with RDoc)

Please feel free to still report issues here for both projects, especially if you aren't sure.

As maintainer of both projects, I'll see if I can identify the root of the cause :bow: :bow: :bow:
Please feel free to still report issues here for both projects, especially if you aren't sure. We will try to redirect to the proper place if necessary.

## Contributing

Expand All @@ -104,12 +79,6 @@ You can generate the Ruby default branch documentation by running:
rake test:ruby
```

You can generate merged Rails and Ruby documentation by running:

```bash
rake test:merged
```

The generated documentation will be put into `doc/public` directory.
To view the just generated documentation start up a rack application by running:

Expand All @@ -123,4 +92,5 @@ Then open http://localhost:9292 in the browser to view the documentation.

* Vladimir Kolesnikov ([voloko](https://github.com/voloko))
* Nathan Broadbent ([ndbroadbent](https://github.com/ndbroadbent))
* Zachary Scott ([zzak](https://github.com/zzak))
* Petrik de Heus ([p8](https://github.com/p8))
* ([zzak](https://github.com/zzak))
15 changes: 0 additions & 15 deletions Rakefile
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@ task :default => :test
task :spec => :test

require 'sdoc'
require 'sdoc/merge'
require 'rdoc/task'

rails = File.expand_path "rails"
Expand Down Expand Up @@ -68,20 +67,6 @@ namespace :test do

rdoc.rdoc_files.include("ruby/")
end

desc 'Generates merged test documentation'
task :merged => [rails, :generate_rails, ruby, :generate_ruby, :merge]

task :merge do
SDoc::Merge.new.merge(
[
'--title', 'Rails + Ruby',
'--op', 'doc/public',
'--names', 'rails, ruby',
'doc/rails', 'doc/ruby'
]
)
end
end

ASSETS_PATH = "lib/rdoc/generator/template/rails/resources"
Expand Down
23 changes: 0 additions & 23 deletions bin/sdoc-merge

This file was deleted.

224 changes: 0 additions & 224 deletions lib/rdoc/generator/template/sdoc/_context.rhtml

This file was deleted.

6 changes: 0 additions & 6 deletions lib/rdoc/generator/template/sdoc/_head.rhtml

This file was deleted.

Loading

0 comments on commit 9a66648

Please sign in to comment.