18 Commits
Author SHA1 Message Date
Henry Schreiner 63daa02352 docs: fix options page (#1821)
Signed-off-by: Henry Schreiner <henryschreineriii@gmail.com>
2024-05-12 00:51:20 -04:00
Joe Rickerby 75c93112dc Update mkdocs and fix resulting issues 2022-08-16 22:53:11 +01:00
Joe RickerbyandHenry Schreiner b6a862a3ff Add a mkdocs extension to generate the --help output (#720)
* Add a mkdocs extension to generate the --help output

* Add the correct setuptools syntax for relative requirements

* docs: use macro plugin instead

* docs: remove indirection in docs

Co-authored-by: Henry Schreiner <henryschreineriii@gmail.com>
2021-06-22 12:18:22 +00:00
Joe Rickerby 5fed3e2948 Fix mkdocs "Edit in Github" links 2021-05-28 08:50:49 +01:00
Henry SchreinerandJoe Rickerby 3be2d0c356 chore: rename joerick/cibuildwheel -> pypa/cibuildwheel (#682)
* chore: rename joerick/cibuildwheel -> pypa/cibuildwheel

* Update Appveyor status badge markup

Note that it still has joerick/cibuildwheel - confusingly it's still within my appveyor account, but this is the new project that points to the pypa github repo

* Update Appveyor badge markup again

I went through a few passes to enable that project, here's the latest.

* Update Azure badge, also

* Update Travis badge to reference the .com

Co-authored-by: Joe Rickerby <joerick@mac.com>
2021-05-24 10:21:03 -04:00
Matti Picus 07447ff66c add search plugin (#616) 2021-03-04 12:17:30 +01:00
Henry SchreinerandJoe Rickerby 58c5e56e9f docs: support tabs (#576)
* docs: support tabs

* Get superfences working

* Use an 'admonition' as a tab, add some styling

* docs: reorder tabs and modernize

* docs: tabbed options settings

* docs: reorder to match order in other places

* docs: correct the example

* Apply suggestions from code review (lazy edits in GH :) )

* Update mkdocs-include-markdown-plugin and remove unneeded include option

Co-authored-by: Joe Rickerby <joerick@mac.com>
2021-02-12 11:08:43 -05:00
Joe Rickerby 4f4dae27fb Merge pull request #474 from henryiii/docs/stars
docs: table and add stars
2020-12-13 16:53:37 +00:00
Joe Rickerby c217d5963d Add working examples and changelog docs pages 2020-12-12 18:29:46 +00:00
Álvaro Mondéjar eae34832ec Separate 'mkdocs_include_markdown_plugin' from project (#475) 2020-12-06 16:55:04 +01:00
Yannick Jadoul 328a6714e9 Enable pymdownx.magiclink to get automatic links for URLs in the Markdown docs 2020-05-04 00:32:18 +02:00
Grzegorz Bokota 9cb796edcd update docs 2020-01-16 16:10:05 +01:00
Joe Rickerby 1446529f7c Sort out page titles 2019-11-03 19:06:33 +00:00
Joe Rickerby 5db3763b2d Add plugin to import sections of readme into the documentation 2019-11-03 18:30:15 +00:00
Joe Rickerby bb2a5f8d17 Formatting improvements 2019-10-06 20:36:21 +01:00
Joe Rickerby 93663d19df Move changelog back into the readme 2019-10-06 11:38:24 +01:00
Joe Rickerby c006fdab36 Migrate more README over to the docs 2019-10-02 09:49:31 +01:00
Joe Rickerby d280f0f16a Add options to docs 2019-09-29 21:53:18 +01:00