<== blog page - 4/6 ==> Blog notebook (8) sphinx (13)
blog page - 4/6¶
Issue with package_data (setup.py)¶
2016-09-07
File setup.py
usually defines something like:
…
Major changes¶
2016-09-03
I now use YAML to define a build script.
See .local.jenkins.win.yml.
I did not expect that to be so long but it did not scale anymore.
So the process is basically to run a script which interprets the
file .local.jenkins.win.yml
as a series of Jenkins jobs.
Unfortunately, I discovered many issues for some modules
refusing to work from a virtual environment on Windows.
It starts by running function
setup_jenkins_server_yml
.
The rest is pressing buttons.
Generate the documentation on Anaconda¶
2016-08-27
On Anaconda, the documentation generation fails for two reasons. The first one is the current version of Sphinx (1.4.1) and pyquickhelper requires >= 1.4.5. After fixing it with pip, the following exception happens (only on Anaconda) on a virtual environment:
…
Make a reference to a blog post¶
2016-06-11
Make a reference to the label label-to-this-blogpost
to reference this blog post. Look at the source of this page
to see how this id was specified.
Sphinx extensions in pyquickhelper¶
2016-04-04
Sphinx extensions implemented were move to a dedicated subfolder sphinxext:
…
Share buttons on a page from the documenation.¶
2016-02-14
pyquickhelper now includes a directive and a role to share
a page from the documentation on networks.
See ShareNetDirective
and sharenet_role
.
The syntax is the following:
...
Bigger text in the documentation¶
2016-02-14
pyquickhelper now includes a role bigger which make a text bigger
...
read_csv and zip files¶
2016-02-06
read_csv is no longer able to extract a dataframe from a zip file. The parameter format changed for compression but the zip format disappeared from the list. I assume the reason is that zip files can contains many files.
…
Badge for coverage¶
Sphinx extensions¶
2015-12-12
The following repository birkenfeld/sphinx-contrib/ contains many useful extensions to improve the rendering of Sphinx documentation:
…
<== blog page - 4/6 ==> 2020-08 (2) 2020-09 (1) 2021-01 (1) 2022-03 (1) 2023-05 (1)