rsmp-nordic / rsmp_sxl_traffic_lights

RSMP Signal Exchange List (SXL) for Traffic Controllers
MIT License
12 stars 4 forks source link

Collect appendencies in a Sphinx document #92

Closed otterdahl closed 4 years ago

otterdahl commented 4 years ago

Collect all appendices into a sphinx document. We can then generate html and show with GitHub Pages, like we want to do for core. From the markdown doc we can then link to the html page where relevant. Discussed in #64

otterdahl commented 4 years ago

This branch is almost ready.

emiltin commented 4 years ago

We don't have to touch the master branch yet? Once 1.0.15-draft is ready, we merge it into master. I think it would make to publish the SXL via sphinx->html as well. But if we want to generate it automatically from an authoritative yaml source, we need to a tool first? Or we can update the sphinx docs manually.

otterdahl commented 4 years ago

OK. I'll include the SXL in the sphinx documentation. I'll leave the master branch alone for now

emiltin commented 4 years ago

what is the various python code used for? is that extensions for sphinx ?is that something that should be common between core and sxl?

otterdahl commented 4 years ago

what is the various python code used for? is that extensions for sphinx?is that something that should be common between core and sxl?

The python code are extensions, mostly from https://github.com/jterrace/sphinxtr. They make (primarily) the PDF output look better.

I don't know if it's worth the trouble trying to make them common between core and sxl.

emiltin commented 4 years ago

ok. you're welcome to merge then if you like. github can only publish from the master branch, so we can't really see the result until 1.0.15-draft is merged in to master.

otterdahl commented 4 years ago

Ok. I'll rebase and merge

otterdahl commented 4 years ago

Use can see the draft here as PDF and here as HTML. I've updated sxl-tools to output the sxl to rst format.

emiltin commented 4 years ago

Cool. I noticed that tables are called 'Table 13: S0001' in the pdf, and 'Figure 2.12: S0001' in the html. Nice that rst is output as well, since this can be shown on github.