ch0ic3/cutter
1
0
Fork 0
mirror of https://github.com/rizinorg/cutter.git synced 2024-12-19 11:26:11 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Explain how to build Cutter docs (#2380)

Browse Source
This commit is contained in:
tsunekoh 2020-08-16 14:48:13 +09:00 committed by GitHub
parent 48192d799a
commit 2e573cc171
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 48 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/source/contributing.rst
View File

@ -24,6 +24,6 @@ So you like Cutter and want to get involved? Great! This part of the documentati
:titlesonly:
contributing/code
Contributing Documentation <contributing/docs/getting-started>
contributing/docs
contributing/translations/getting-started
contributing/plugins/getting-started
contributing/plugins/getting-started

8
docs/source/contributing/docs.rst Normal file
View File

@ -0,0 +1,8 @@
Contributing Documentation
==========================
.. toctree::
:maxdepth: 2
Getting Started <docs/getting-started>
docs/building-docs

37
docs/source/contributing/docs/building-docs.rst Normal file
View File

@ -0,0 +1,37 @@
Building docs
=======================
This page explains the steps that are needed to build Cutter's documentation.
Requirements
------------
You will need:
* doxygen
* python3
* pip3
* sphinx
* breathe
* recommonmark
On Debian-based Linux distributions, the packages above can be installed with the following command.
.. code:: sh
sudo apt install make doxygen python3-pip doxygen
sudo pip3 install sphinx breathe recommonmark
Then, you can build the documentation with the following commands:
.. code:: sh
cd cutter/docs/
make html
.. tip::
If you do not need API documentation, type ``make quick`` instead of ``make html``.
You can find the generated html files at ``cutter/docs/build``. Open ``cutter/docs/build/html/index.html`` with your browser to visit the index file of your local copy of the documentation.

3
docs/source/contributing/docs/getting-started.rst
View File

@ -16,8 +16,7 @@ How can you help?
The following sections suggest ways you can contribute to Cutter's documentation. The list isn't complete as the possibilities are limitless.
The source for this documentation is available in the `docs directory <https://github.com/radareorg/cutter/tree/master/docs>`_ on Cutter's repository. When the docs are updated, they are generated and pushed directly to the website at <https://cutter.re/docs>. The source for the website and blog are available on the `cutter.re's repository <https://github.com/radareorg/cutter.re>`_ and are served from the ``gh-pages`` branch.
The source for this documentation is available in the `docs directory <https://github.com/radareorg/cutter/tree/master/docs>`_ on Cutter's repository. This source can be generated according to the steps described in the :ref:`building docs page<contributing/docs/building-docs:Building docs>`. When the docs are updated, they are generated and pushed directly to the website at <https://cutter.re/docs>. The source for the website and blog are available on the `cutter.re's repository <https://github.com/radareorg/cutter.re>`_ and are served from the ``gh-pages`` branch.
.. tip::
Document what you wished to see. If you are a user of Cutter, try to think what things you would want to see documented when you started using the project. Sometimes, the best contributions are coming from your own needs.