<== blog page - 5/6 ==> Blog notebook (8) sphinx (13)
blog page - 5/6¶
Python code to generate part of sphinx documentation¶
2015-12-12
I used the same title as a question asked on stackoverflow:
Python code to generate part of sphinx documentation, is it possible?.
It became the following
RunPythonDirective
which does the same with more options:
...
Local contents in Sphinx¶
2015-12-05
The Sphinx command contents adds a table of contents to a page. As contents is pretty common, on the web, it is not always easy to search for it:
...
A few tips with Sphinx¶
2015-10-10
Sphinx generates many warning when it builds the documentation despite the fact the result looks good. Some cases.
…
Why do I see invered question in a notebook converted into PDF?¶
2015-08-30
The function process_notebooks
still uses the executable
pdflatex
and not
xetex
which can handle inline unicode characters.
That’s why they are replaced by ¿ by function
post_process_latex.
Issue with module babel¶
2015-08-17
I went through the following issue with the latest version of babel (2.0). It happens when I try to generate the documentation for this module. It gave me the following exception:
...
Convert a notebook into slides¶
2015-05-16
I thought it would be easy to convert a notebook into slides. I would just have to execute nbconvert. I went through two issues. The first one came from reveal.js. My first tries did not work. I decided to take the version included in the module sphinxjp.themes.revealjs and I also updated the output of nbconvert to remove external links as much as possible.
…
Add a custom menu to the notebook¶
2015-05-14
The function add_notebook_menu
add HTML and Javascript to the notebook to create links to all sections in
the notebook:
...
Create a script to read this blog¶
2015-05-10
The module now includes a function
write_module_scripts
creates a script auto_rss_server.py which grabs the latest blog post
from this stream, runs a server and opens the default browser to read them.
It uses the module
pyrsslocal.
Here is the code to read this blog:
...
Frequent commands and automation¶
2015-05-06
The script setup.py accepts several options
such as install or build. It also accepts
unittest to run the unit tests or build_sphinx
to build the documentation.
It usually requires to have a command line windows opened
as well as an editor to write programs.
On Windows, the module now produces a series of scripts
to automate tasks such as running the unit tests,
building the documentation. They are not included in the sources
anymore but the can be obtained by typing:
...
Visualize differences between two files in a notebook¶
2015-04-23
It is now possible to visualize the differences between two files directly from a notebook:
…
<== blog page - 5/6 ==> 2020-08 (2) 2020-09 (1) 2021-01 (1) 2022-03 (1) 2023-05 (1)
