mirror of
https://github.com/rizinorg/cutter.git
synced 2024-12-28 15:55:26 +00:00
Explain how to build Cutter docs (#2380)
This commit is contained in:
parent
48192d799a
commit
2e573cc171
docs/source
@ -24,6 +24,6 @@ So you like Cutter and want to get involved? Great! This part of the documentati
|
|||||||
:titlesonly:
|
:titlesonly:
|
||||||
|
|
||||||
contributing/code
|
contributing/code
|
||||||
Contributing Documentation <contributing/docs/getting-started>
|
contributing/docs
|
||||||
contributing/translations/getting-started
|
contributing/translations/getting-started
|
||||||
contributing/plugins/getting-started
|
contributing/plugins/getting-started
|
8
docs/source/contributing/docs.rst
Normal file
8
docs/source/contributing/docs.rst
Normal 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
37
docs/source/contributing/docs/building-docs.rst
Normal 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.
|
@ -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 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::
|
.. 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.
|
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.
|
||||||
|
Loading…
Reference in New Issue
Block a user