Comments (9)
@alexanderhiam I wrote a script to (kind of) make it easy to generate a PDF from the wiki.
https://gist.github.com/anujdeshpande/0ddf9d4b7d315c6b818e
Some changes to the wiki might be required : too many carriage returns at the end of the page has resulted in a number of blank pages in the final PDF.
Embedded links is another.
Another issue that I am getting my head around is the page numbers.
But good enough to get started I guess.
from pybbio.
Nice! Yeah, I'll have to clear some white space.
I'd also like to include the main page with the pinout diagram, and it would be great to generate a toc from those links. That may require using something like panadoc as a last step.
from pybbio.
I tried pandoc initially. Directly converted the markdown files from the wiki git repo, but hated the formatting. Especially the code blocks. This one is a bit complicated but prettier.
from pybbio.
If I remember right you can specify the stylesheet to use for markdown conversion in pandoc, so it could just use the Github stylesheet.
from pybbio.
And PyPDF2 may also be able to do all that, I've never used it.
from pybbio.
Yepp, it does that with grip too (easier thn pandoc), but thought it would be a better look/feel than the same old gfm.
PyPDF2 mostly does merging and stuff. Also handling the headers, encryption etc.
from pybbio.
Hi all!
Why not using Sphinx with reStructuredText
for the documentation?
- it can easily generates doc from code (supporting both C and Python);
- it is supported by GitHub;
- it lets you easily generate PDF and HTML for online documentation, even using online services such as Read The Docs. You can even add the GitHub repo to RTD to keep them synchronised.
I can create a new issue and eventually helping out porting the documentation to that format.
from pybbio.
@lucalenardi I'd like to use something like Sphinx in the long run, but I don't have the time now to make that switch, so I want to do something quicker in the interim.
from pybbio.
OK, it's time to bite the bullet and convert to using Sphinx - see issue #88
from pybbio.
Related Issues (20)
- I2C Library
- Unable to use PWM1A and PWM1B at the same time HOT 2
- Analog In not recognized HOT 4
- pwmFrequency int division vs float division
- GPIO resource busy error
- SPI0.write crashes Beagleblone HOT 1
- SPI0.write crashes Beagleblone HOT 1
- Questions about Contributions HOT 1
- Pull-ups, pull-down configuration issue
- GPIO configuration bug HOT 2
- SystemError: NULL result without error in PyObject_Call when testing blink.py
- example blink.py error with beaglebone black HOT 2
- BBIOServer_test.py error HOT 4
- MAX31855_test.py problem HOT 4
- importing bbio causes immediate segfault HOT 8
- WebCam - no module named gst HOT 1
- GPIO does not work after "bbio.pinMode" HOT 3
- no module named WebCam HOT 9
- Problem running PyBBIO ADC code on BBB attached to 4D Systems 4DCAPE HOT 8
- not an issue but a doubt HOT 3
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from pybbio.