restructuredtext

How to define the the height of the csv table in reStructuredText?

冷暖自知 提交于 2021-02-05 08:47:26
问题 I'm using this code to create a table from csv for my documentation in readthedocs: .. csv-table:: Markram et al. Model & Network configuration file :file: ../config_files/Markram_config_file.csv :header-rows: 1 The CSV is large and has a lot of rows and columns. For columns, everything is fine since it just fits a few columns in the page and the others can be accessed by scrolling to the right in the table. However, all of the rows are placed in the the page and I cannot specify a particular

How to define the the height of the csv table in reStructuredText?

血红的双手。 提交于 2021-02-05 08:47:26
问题 I'm using this code to create a table from csv for my documentation in readthedocs: .. csv-table:: Markram et al. Model & Network configuration file :file: ../config_files/Markram_config_file.csv :header-rows: 1 The CSV is large and has a lot of rows and columns. For columns, everything is fine since it just fits a few columns in the page and the others can be accessed by scrolling to the right in the table. However, all of the rows are placed in the the page and I cannot specify a particular

Markdown output for Sphinx based documentation [closed]

ぃ、小莉子 提交于 2021-02-04 09:19:08
问题 Closed. This question does not meet Stack Overflow guidelines. It is not currently accepting answers. Want to improve this question? Update the question so it's on-topic for Stack Overflow. Closed 3 years ago . Improve this question I found myself with a use case, where in addition to generating HTML and PDF from my Sphinx based documentation sources, I would also like to generate a Markdown version of the reStructuredText source files. My preliminary research didn't find any core or

genindex and modindex footer links don't work in readthedocs.io

纵饮孤独 提交于 2021-01-29 06:49:46
问题 I have a Python project using Sphinx for docs. I am building the docs remotely on readthedocs.io service. I used sphinx-quickstart and it generated an index.rst file with these links in the footer: Indices and tables ~~~~~~~~~~~~~~~~~~ * :ref:`genindex` * :ref:`modindex` * :ref:`search` When I push changes to readthedocs.io and build the docs, my build succeeds. Docs that I manually linked via toctree directive all work fine. The search link works fine. But the genindex link goes to an empty

custom char for bulletlist sphinx

时间秒杀一切 提交于 2021-01-28 05:25:37
问题 There is someway to change the the default bullet 'disc'/'circle' on sphinx ? i tried something like the solution from https://groups.google.com/forum/#!topic/sphinx-users/fNWyyRzoa8I but it doesn't work for me, possibly because i'm not familiar with html and css syntax. _static/custom.css: ul.squarelist { list-style-type: square; margin-left: 0; padding-left: 0; } li.squarelist { padding-left: 1em; text-indent: -1em; } test.rst: .. cssclass:: squarelist * foo * bar output -> test.html: <ul

Possible to define a target conditonally using `ifconfig` block (reStructuredText)

99封情书 提交于 2021-01-28 03:18:42
问题 Is it possible to condtionally define a target in a reStructuredText file using ifconfig? I've set a variable in my sphinx conf.py file that I want to use to conditionally determine the URI of a target in my documentation: def setup(app): argv = ' '.join(sys.argv) if '-b html' in argv: app.add_config_value('buildername', 'html', 'env') else: app.add_config_value('buildername', 'not-html', 'env') And my index.rst file has the following content: test link to target1_ .. ifconfig:: buildername =

Possible to define a target conditonally using `ifconfig` block (reStructuredText)

此生再无相见时 提交于 2021-01-28 01:41:33
问题 Is it possible to condtionally define a target in a reStructuredText file using ifconfig? I've set a variable in my sphinx conf.py file that I want to use to conditionally determine the URI of a target in my documentation: def setup(app): argv = ' '.join(sys.argv) if '-b html' in argv: app.add_config_value('buildername', 'html', 'env') else: app.add_config_value('buildername', 'not-html', 'env') And my index.rst file has the following content: test link to target1_ .. ifconfig:: buildername =

Python docstrings to Github README.md

爷,独闯天下 提交于 2020-11-30 20:45:10
问题 How do I transcode python doc strings to Github readme.md ? Even though it seems like something everyone does, I cannot seem to get a decent solution and I am assuming it should be easy, so it seems unlikely folks are going throw two converters… What I have tried pydoc Actually simple. The output of pydoc is manpages (groff format for UNIX systems). Which is a dead end as man to md is not a thing. Via HTML, pydoc3 -w + pandoc, utterly munges the docstrings to bits. custom code There seems to

Python docstrings to Github README.md

天涯浪子 提交于 2020-11-30 20:42:12
问题 How do I transcode python doc strings to Github readme.md ? Even though it seems like something everyone does, I cannot seem to get a decent solution and I am assuming it should be easy, so it seems unlikely folks are going throw two converters… What I have tried pydoc Actually simple. The output of pydoc is manpages (groff format for UNIX systems). Which is a dead end as man to md is not a thing. Via HTML, pydoc3 -w + pandoc, utterly munges the docstrings to bits. custom code There seems to

Python docstrings to Github README.md

China☆狼群 提交于 2020-11-30 20:39:09
问题 How do I transcode python doc strings to Github readme.md ? Even though it seems like something everyone does, I cannot seem to get a decent solution and I am assuming it should be easy, so it seems unlikely folks are going throw two converters… What I have tried pydoc Actually simple. The output of pydoc is manpages (groff format for UNIX systems). Which is a dead end as man to md is not a thing. Via HTML, pydoc3 -w + pandoc, utterly munges the docstrings to bits. custom code There seems to