Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove user docs from cutter repository #2399

Draft
wants to merge 3 commits into
base: dev
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 45 additions & 0 deletions .github/workflows/documentation.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
name: Cutter Documentation

on:
push:
branches: [ main ]
pull_request:
branches:
- master

jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Install dependencies
run: sudo apt-get install doxygen
- name: Build docs
run: |
cd docs
doxygen

- name: Checkout deploy target
if: ${{ github.event_name == 'push' }}
uses: actions/checkout@v2
with:
repository: 'karliss/github-integration-test' # TODO: replace with radareorg/cutter.re
path: 'deploy-checkout'
ref: master
ssh-key: ${{ secrets.DOC_UPLOAD_SSH_KEY }}

- name: Copy files
if: ${{ github.event_name == 'push' }}
run: |
rm -r deploy-checkout/doc/api/latest/* || true
mkdir -p deploy-checkout/doc/api/latest
cp -r cos/doxygen-out/html/* deploy-checkout/doc/api/latest
- name: Commit and push
if: ${{ github.event_name == 'push' }}
uses: EndBug/add-and-commit@a988073222b8bd50f3ecfca9c0ab7dfbf0d08ceb # v4.4.0
with:
cwd: deploy-checkout
message: ${{ format('Upate docs from {0}@{1}', github.repository, github.sha) }}
force: false
ref: master
add: docs
36 changes: 0 additions & 36 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -90,42 +90,6 @@ matrix:
brewfile: scripts/Brewfile
update: true # updating brew to get slightly newer meson, 0.54 doesn't work on macOS.

- name: Documentation + Deploy
os: linux
cache: ~
addons:
apt:
packages:
- doxygen
- libgraphviz-dev
before_install:
- pyenv global 3.7
- pip3 install -U sphinx
- pip3 install -U breathe
- pip3 install -U sphinx-rtd-theme
- pip3 install -U recommonmark
install: ~
before_script: ~
after_success: ~
script:
- cd docs
- make html
before_deploy:
- cd "$TRAVIS_BUILD_DIR"
- openssl aes-256-cbc -K $encrypted_bd0ed4c1fd75_key -iv $encrypted_bd0ed4c1fd75_iv -in scripts/deploy_docs_rsa.enc -out scripts/deploy_docs_rsa -d
- chmod 600 scripts/deploy_docs_rsa
- export GIT_SSH_COMMAND="/usr/bin/ssh -i $TRAVIS_BUILD_DIR/scripts/deploy_docs_rsa"
- git config --global user.name "Travis CI"
- git config --global user.email "[email protected]"
deploy:
skip_cleanup: true
provider: script
script: bash scripts/deploy_docs.sh
on:
repo: radareorg/cutter
branch: master


sudo: required
dist: bionic

Expand Down
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Please follow our contribution guidelines: https://cutter.re/docs/contributing.h

## Contributing to the documentation

The documentation is something important for newcomers. As of today the documentation can be found [here](https://cutter.re/docs/) and it stands in the [docs](https://github.com/radareorg/cutter/tree/master/docs) folder.
The documentation is something important for newcomers. As of today the documentation can be read [here](https://cutter.re/docs/) and it's source code stands in the [cutter-docs](https://github.com/radareorg/cutter-docs) repository.
The API Reference is automatically generated from the source code, so it is strongly advised to document your code.
Check issues marked as "Documentation" on our issues [list](https://github.com/radareorg/cutter/issues?q=is%3Aissue+is%3Aopen+label%3ADocumentation).

Expand Down
3 changes: 0 additions & 3 deletions docs/.gitignore
Original file line number Diff line number Diff line change
@@ -1,4 +1 @@
/doxygen-out
/build
/source/api
/source/_build
4 changes: 2 additions & 2 deletions docs/Doxyfile
Original file line number Diff line number Diff line change
Expand Up @@ -170,7 +170,7 @@ FULL_PATH_NAMES = YES
# will be relative from the directory where doxygen is started.
# This tag requires that the tag FULL_PATH_NAMES is set to YES.

STRIP_FROM_PATH =
STRIP_FROM_PATH = ..

# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
# path mentioned in the documentation of a class, which tells the reader which
Expand Down Expand Up @@ -1983,7 +1983,7 @@ MAN_LINKS = NO
# captures the structure of the code including all documentation.
# The default value is: NO.

GENERATE_XML = YES
GENERATE_XML = NO

# The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
Expand Down
27 changes: 2 additions & 25 deletions docs/Makefile
Original file line number Diff line number Diff line change
@@ -1,30 +1,7 @@
# Minimal makefile for Sphinx documentation
#
.PHONY: doxygen-out

# You can set these variables from the command line.
SPHINXOPTS =
SPHINXBUILD = sphinx-build
SOURCEDIR = source
BUILDDIR = build

# Put it first so that "make" without argument is like "make help".
help:
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

.PHONY: help Makefile

# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
doxygen-out: Makefile Doxyfile
doxygen
python3 apidoc.py
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

quick:
@$(SPHINXBUILD) -M html "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

clean:
rm -fr doxygen-out
rm -fr source/api
rm -fr build
@$(SPHINXBUILD) -M clean "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS)
136 changes: 0 additions & 136 deletions docs/apidoc.py

This file was deleted.

51 changes: 0 additions & 51 deletions docs/cutter_theme/layout.html

This file was deleted.

Loading