I've figure out that if I add:
html_additional_pages = {
'schema1': 'schema1.html' }
to my conf.py, I can get my schema1.html file located in my _templates
folder to appear and work correctly with the dynamic content.
However, I don't seem to be able to link to it from my toctree in my
index.rst file.
Is it possible to link to an html file in "_templates" folder from an item
in my toctree?
On Friday, April 6, 2018 at 6:46:23 PM UTC+12, Jan wrote:
>
> I ended up trying something which gets me part of what I'm looking for,
> but still leaves me without the structure I'm looking for.
>
> To get a nice looking html table which I could control formatting with a
> custom CSS, I placed a "custom.css" file in a "_static" folder. I also
> placed a "page.html" file in a "_templates" folder. That page html file
> looks like this:
> {% extends "!page.html" %}
> {{ super() }}
> {% block body %}
> {% filter upper %}
> Schema: {{ schema_gen["name"] }}
> {% endfilter %}
> Description: {{ schema_gen["comment"] }}
>
>
>
> {% for item in outputschema %}
> Table Name: {% filter upper %} {{ item["table_nam"] }} {% endfilter
> %}
> Description: {{ item["table_comment"] }}
> {% if item["table_columns"] %}
>
>
>
>
> Column Name
> Data Type
> Length
> Precision
> Scale
> Description
>
>
> {% for columns in item["table_columns"] %}
>
> {% for column in columns %}
> {{ column }}
>
> {% endfor %}
>
> {% endfor%}
>
>
> {% endif %}
>
> {% endfor %}
>
>
>
> {% endblock %}
>
> After uploading to my repo, Sphinx automatically generated my ReadTheDocs
> docs and created a very nice looking index.html page with my tables
> formatted correctly, and using the css I needed.
>
> I'm still confused because this created my tables in my INDEX page. How do
> I leave my index page intact (containing other ReStructureText content)
> without my inherited "page.html" content, but have a sub-page listed in my
> index page toctree with this new html content (ie schema1) ?
>
> My index.rst:
>
> .. toctree::
>
>schema1
>schema2
>
> I want my schema1.html file to contain my tables as I've dynamically
> generated them in the code block above.
> I'm quite confused about how I can potentially use the inheritance
> templating to work in a single subpage only, rather than in my index page.
>
> I tried putting a file named schema1.html in my "_templates" folder, but
> that didn't do anything.
>
> I must be missing something quite fundamental to inheritance in Sphinx.
> What am I not understanding?
>
>
>
> On Thursday, March 29, 2018 at 2:50:00 PM UTC+13, Peter Burdine wrote:
>>
>> A few things:
>> 1) You may want to consider another jinja extension to sphinx:
>> https://pypi.python.org/pypi/sphinx-jinja. We use YAML as the
>> datasource, though it could be anything maps to Python lists/dicts (json,
>> xml, etc). You can then either reference the a file with the jinja
>> template, or you can embed the jinja code in your .rst files. We have
>> found it is easiest to make list tables for this. You can use
>> {% if loop.first %}
>> to setup your table headers.
>>
>>
>> 2) The builder controls the output formatting not the reST input (unless
>> you use tablularcolumns for LaTeX, but that is another story). Have you
>> tried:
>> https://stackoverflow.com/questions/23462494/how-to-add-a-custom-css-file-to-sphinx
>>
>>
>> On Wednesday, March 28, 2018 at 12:45:44 AM UTC-7, Jan wrote:
>>>
>>> I'm trying to understand sphinx, and I'm thoroughly not understanding
>>> how to implement even some basic concepts. I've created a sphinx project
>>> linked to my readthedocs account. Everything works to generate my basic
>>> index.rst file in read the docs. I'm trying to follow the ideas of adding
>>> dynamic input to a specific page within my project, as mentioned here:
>>> http://ericholscher.com/blog/2016/jul/25/integrating-jinja-rst-sphinx/
>>>
>>> My objective is to setup my sphinx project so that whenever a specific
>>> text file changes in my /docs folder, it updates my ReadTheDocs content
>>> dynamically/automatically.
>>>
>>> My /docs folder has these key elements:
>>>
>>> parsethisfile.txt
>>> conf.py
>>> index.rst
>>> Database.rst
>>> ...
>>>
>>> In my conf.py I've added some python which parses a txt file, and then
>>> creates references to the object:
>>>
>>> def rstjinja(app, docname, source):
>>> """
>>> Render our pages as a jinja template for fancy templating goodness.
>>> """
>>> # Make sure we're outputting HTML
>>> if app.builder.format != 'html':
>>> return
>>> src = source[0]
>>> rendered = app.builder.templates.render_string(
>>> src, app.config.html_context
>>> )
>>> source[0] = rendered
>>>
>>> def setup(app):
>>> app.connect("source-read", rstjinja)
>>>
>>> html_context = {
>>> #'outputschema': schema_list_out
>>> }
>>>
>>> The "schema_list_out" is a list (or I could make a dictionary) which
>>> contains elements for a dat
