Put counter board output into separate tabs.

[mithro]

Fixes #164

Signed-off-by: Tim 'mithro' Ansell [email protected]

[mithro]

This is currently failing with;

(venv) tansell@tansell-glapstation:~/github/SymbiFlow/symbiflow-examples$ make -C docs html                                                                                                                                            
make: Entering directory '/ssd/github/SymbiFlow/symbiflow-examples/docs'                                                                                                                                                               
Running Sphinx v4.3.2                                                                                              
<string>:49: (ERROR/3) Unknown directive type "tabs".                                                              
                                                         
.. tabs::                                  
                                                                                                                   
   .. tab:: Arty and Basys 3

[mithro]

I believe this is being caused by https://github.com/SymbiFlow/symbiflow-examples/blob/master/docs/collect_readmes.py which was added by @rw1nkler and modified by @fkokosinski

GitHub

symbiflow-examples/collect_readmes.py at master · SymbiFlow/symbiflow-examples

Example designs showing different ways to use SymbiFlow toolchains. - symbiflow-examples/collect_readmes.py at master · SymbiFlow/symbiflow-examples

[mithro]

The issue seems to be the line @ https://github.com/SymbiFlow/symbiflow-examples/blob/master/docs/collect_readmes.py#L205 which calls publish_doctree without the correct arguments for the sphinx context. A quick Googling seems to indicate you need to do something more like this;

https://github.com/sphinx-doc/sphinx/blob/eed0730b4ba3bd2fbd34f2d6ab555ba876c77717/sphinx/testing/restructuredtext.py#L29-L33

def parse(app: Sphinx, text: str, docname: str = 'index') -> nodes.document:
    """Parse a string as reStructuredText with Sphinx application."""
    try:
        app.env.temp_data['docname'] = docname
        reader = SphinxStandaloneReader()
        reader.setup(app)
        parser = RSTParser()
        parser.set_application(app)
        with sphinx_domains(app.env):
            return publish_doctree(text, path.join(app.srcdir, docname + '.rst'),
                                   reader=reader,
                                   parser=parser,
                                   settings_overrides={'env': app.env,
                                                       'gettext_compact': True})
    finally:
        app.env.temp_data.pop('docname', None)

GitHub

symbiflow-examples/collect_readmes.py at master · SymbiFlow/symbiflow-examples

Example designs showing different ways to use SymbiFlow toolchains. - symbiflow-examples/collect_readmes.py at master · SymbiFlow/symbiflow-examples

GitHub

sphinx/restructuredtext.py at eed0730b4ba3bd2fbd34f2d6ab555ba876c77717 · sphinx-doc/sphinx

Main repository for the Sphinx documentation builder - sphinx/restructuredtext.py at eed0730b4ba3bd2fbd34f2d6ab555ba876c77717 · sphinx-doc/sphinx