docs website

[tomeichlersmith]

Need a few things

• [x] doxygen-generated docs for C++ API
• [ ] sphinx-generated docs for Python API
• [x] some jekyll nonsense to hold it all together: https://docs.github.com/en/pages/setting-up-a-github-pages-site-with-jekyll/creating-a-github-pages-site-with-jekyll
• [x] CI for updating docs as pushes to main occur
• [x] design decisions and their motivations write up
• [x] contributing doc outlining how mono-repo is structured
• [ ] a "From ROOT" doc

[tomeichlersmith]

https://idratherbewriting.com/documentation-theme-jekyll/

[tomeichlersmith]

https://dbgdiary.blogspot.com/2015/11/piping-doxygen-output-to-github-pages.html

[tomeichlersmith]

Following https://jekyllrb.com/docs/installation/ubuntu/ and then https://docs.github.com/en/pages/setting-up-a-github-pages-site-with-jekyll/creating-a-github-pages-site-with-jekyll to initialize docs site.

[tomeichlersmith]

Docs on Docs

Install Ruby and RubyGems

sudo apt-get install ruby-full build-essential zlib1g-dev

In order to avoid cluttering my home directory, I put the gems into my working tree.

export GEM_HOME=$PWD/.gems
export PATH=${PATH}:${GEM_HOME}/bin

Install basics

gem install jekyll bundler

Then use bundle to interact with site.

bundle install
bundle exec jekyll serve

[tomeichlersmith]

https://stackoverflow.com/questions/7890160/embed-website-into-my-site

[tomeichlersmith]

The documentation theme comes with some short scripts using container-ized jekyll to develop the site locally. I am going to use that instead of documenting how to do things on bare metal.

[tomeichlersmith]

Big structure is there so I'm closing this up, will open separate issues for other, more specific tasks.