Skip to content

Commit

Permalink
Merge pull request #3659 from gpaumier/patch-1
Browse files Browse the repository at this point in the history
Add note about how to debug with doit
  • Loading branch information
Kwpolska committed Jan 6, 2023
2 parents 9fc33fd + 33520fe commit c6e44c5
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions docs/internals.rst
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ The Build Command

Nikola's goal is similar, deep at heart, to a Makefile. Take sources, compile them
into something, in this case a website. Instead of a Makefile, Nikola uses
`doit <https://pydoit.org>`_
`doit <https://pydoit.org>`_.

Doit has the concept of "tasks". The 1 minute summary of tasks is that they have:

Expand All @@ -64,7 +64,11 @@ basename:name
.. sidebar:: More about tasks

If you ever want to do your own tasks, you really should read the doit
`documentation on tasks <https://pydoit.org/tasks.html>`_
`documentation on tasks <https://pydoit.org/tasks.html>`_.

Notably, by default doit redirects ``stdout`` and ``stderr``. To get a
proper PDB debugging shell, you need to use doit's own
`set_trace <https://pydoit.org/tools.html#set-trace>`_ function.

So, what Nikola does, when you use the build command, is to read the
configuration ``conf.py`` from the current folder, instantiate
Expand Down

0 comments on commit c6e44c5

Please sign in to comment.