Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation enhancement #89

Open
roblabla opened this Issue Jan 25, 2018 · 3 comments

Comments

Projects
3 participants
@roblabla
Copy link
Member

roblabla commented Jan 25, 2018

The documentation PR was a good first step in the right direction, but it still needs a lot of work:

  • The main page is currently set to the README. This doesn't make a whole lot of sense, it should instead be a high level presentation of libtransistor, with a list of "modules"
  • Talking of modules, we should use doxygen's grouping system such that we generate a better looking docs. https://www.stack.nl/~dimitri/doxygen/manual/grouping.html
  • Right now the list of functions is hidden deep. It'd be nice to find a way to put this in the forefront.
@misson20000

This comment has been minimized.

Copy link
Member

misson20000 commented Jan 26, 2018

Kinda silly to add this to the list, but the default Doxygen theme looks terrible. If someone wants to write up some better CSS to better match our other web design (see SwIPC), I'd appreciate it.

@misson20000

This comment has been minimized.

Copy link
Member

misson20000 commented Jan 29, 2018

If anyone wants to play with CSS, here's a WIP stylesheet to make Doxygen look a little more like SwIPC: https://gist.github.com/misson20000/d9d1ec6d8afaa4cfd1a670221429d543

Looks like this right now. (screenshot not marked down as an image because it's really tall)

Still needs quite a bit of work, but the default Doxygen theme is just so bad.

@misson20000 misson20000 added this to Todo in Work Feb 23, 2018

@misson20000 misson20000 moved this from Todo to Todo (Docs) in Work Feb 23, 2018

@qsypoq

This comment has been minimized.

Copy link

qsypoq commented Mar 6, 2018

I started to work on the CSS, suggestions are welcome:
https://qsypoq.github.io/libtransistor/

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.