Install

Install sphinxcontrib-osint via pip :

pip -U install sphinxcontrib-osint

If sphinx is not present, it will be automatically installed.

Create a directory for your quest and cd to it:

mkdir myquest
cd myquest

Create your quest structure using sphinx-quickstart:

sphinx-quickstart

Welcome to the Sphinx 8.1.3 quickstart utility.

Please enter values for the following settings (just press Enter to
accept a default value, if one is given in brackets).

Selected root path: .

You have two options for placing the build directory for Sphinx output.
Either, you use a directory "_build" within the root path, or you separate
"source" and "build" directories within the root path.
> Separate source and build directories (y/n) [n]: n

The project name will occur in several places in the built documentation.

> Project name: MyQuest
> Author name(s): AnonyMouse
> Project release []: 0.0.1

If the documents are to be written in a language other than English,
you can select a language here by its language code. Sphinx will then
translate text that it generates into that language.

For a list of supported codes, see
https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-language.
> Project language [en]: en

Creating file /*****/test/conf.py.
Creating file /*****/test/index.rst.
Creating file /*****/test/Makefile.
Creating file /*****/test/make.bat.

Finished: An initial directory structure has been created.

You should now populate your master file index.rst and create other documentation
source files. Use the Makefile to build the docs, like so:
   make builder
where "builder" is one of the supported builders, e.g. html, latex or linkcheck.

You can check files and directories created :

ls

_build  conf.py  index.rst  make.bat  Makefile  _static  _templates

It’s a good idea to create an include directory to store your data. If you planned to have many informations; you can create subdirs inside include for each country, company, … depending of your quest.

mkdir include

Edit conf.py and add ‘sphinxcontrib-osint’ and ‘sphinx.ext.graphviz’ to sphinx extensions:

extensions = [
    'sphinxcontrib-osint',
    'sphinx.ext.graphviz',
#    'sphinx.ext.todo',
]

It could be a good idea to enable and use sphinx todo <https://www.sphinx-doc.org/en/master/usage/extensions/todo.html>.

Create your first page quest.rst (extension is important) and add a title to it :

====================
My Quest
====================

Open index.rst and add quest to the toctree:

.. toctree::
   :maxdepth: 2
   :caption: Contents:

   quest

Every page in sphinx must be included in a toctree. For some quest, it’s possible to have a master toctree in index and secondary toctrees in pages referenced in the master one.

For more informations on sphinx syntax and concepts, check this documentation.

Now it’s time to populate your quest.