Skip to content

Commit

Permalink
Removing rake tasks and readme instructions. (#750)
Browse files Browse the repository at this point in the history
  • Loading branch information
Oglopf authored Dec 22, 2022
1 parent 2a95b2d commit 2f05cc4
Show file tree
Hide file tree
Showing 2 changed files with 0 additions and 56 deletions.
40 changes: 0 additions & 40 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,46 +53,6 @@ Or use the rake task added:
rake docker:build
```

#### pipenv

If you don't want to use Docker, you can also use pipenv.

1. Ensure plantuml and graphviz are installed:

```bash
# on OS X
brew install plantuml
brew install graphviz
```

2. Install pipenv and use it to install dependencies in same directory:

```bash
pip install -g pipenv
# then in the documentation root directory:
WORKDIR=/doc PIPENV_VENV_IN_PROJECT=1 pipenv install
# or using handy rake task:
rake pipenv:install
```

When building the docs, run this command:

```bash
WORKDIR=/doc PIPENV_VENV_IN_PROJECT=1 pipenv run make html
```

or use the rake task:

```bash
rake pipenv:build
# or
rake build
```

## Contributing

Bug reports and pull requests are welcome on GitHub at
Expand Down
16 changes: 0 additions & 16 deletions Rakefile
Original file line number Diff line number Diff line change
Expand Up @@ -4,22 +4,6 @@ task :default do
system "rake --tasks"
end

namespace :pipenv do
desc "Build docs using pipenv"
task :build do
exec 'WORKDIR=/doc PIPENV_VENV_IN_PROJECT=1 pipenv run make html'
end

task :clean do
exec 'WORKDIR=/doc PIPENV_VENV_IN_PROJECT=1 pipenv run make clean'
end

desc "Install pipenv dependencies"
task :install do
exec 'WORKDIR=/doc PIPENV_VENV_IN_PROJECT=1 pipenv install'
end
end

namespace :docker do

desc "Build docs using docker"
Expand Down

0 comments on commit 2f05cc4

Please sign in to comment.