Commit Graph

18 Commits

Author SHA1 Message Date
ThomasTNO
ef9a0584ef Added support for gtag (#1129)
* Added support for gtag

* Fix missing curly braces

* Simplify gtag script import

* Fix tag

* Add gtag to docs

Co-authored-by: Aaron Carlisle <carlisle.b3d@gmail.com>
2021-06-18 13:59:46 -04:00
Aaron Carlisle
85f23c9edc Docs: Add text before config api type information (#1090)
* Docs: Add text before config api type information

This makes it more clear what the confval is for without having to read through the type information.

This matches usual sphinx autodoc behavior.

* Only use one space above headings
2021-03-15 09:49:13 -05:00
Santos Gallegos
c27ac2944b Use canonical URL from html_baseurl (#1003)
This is in sphinx itself now https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-html_baseurl,
e886cc2171/sphinx/themes/basic/layout.html (L135-L137)
2020-12-03 17:15:40 -05:00
Nils K
e2b60d7e7b Add analytics_anonymize_ip option to theme (#889)
* Add analytics_anonymize_ip option to theme

* Fix typo and use tobool filter

Co-Authored-By: Jesse Tan <jessetan@users.noreply.github.com>

* Simplify analytics_anonymize_ip description

* Update changelog.rst

Co-authored-by: Jesse Tan <jessetan@users.noreply.github.com>
Co-authored-by: Aaron Carlisle <carlisle.b3d@gmail.com>
2020-10-08 19:28:19 -04:00
Reinout van Rees
c04c214a85 Documenting that google analytics is supported (#829)
See #411, released in `0.4.3`. It is now supported, so I've changed the documentation accordingly.
2019-10-23 04:36:31 -04:00
Eric Holscher
d8355ca6ae Fix docs on configuring 2019-02-12 16:34:25 -03:00
Eric Holscher
a81f7448fd Merge branch 'master' into agj/docs-config-updates 2019-02-12 16:12:35 -03:00
Anthony Johnson
dd6a095358 Review updates and more intersphinx 2019-01-22 15:20:53 -07:00
Gergely Csatari
5877f371e5 Correction of documentation comments 2019-01-07 10:26:14 +01:00
Gergely Csatari
17691e9213 Documentation 2019-01-04 08:40:31 +01:00
Jesse Tan
600520c39c Merge branch 'master' into agj/docs-config-updates 2018-12-12 11:44:41 +01:00
Eric Holscher
7e4592f95c Add support for Google Analytics to theme. (#411)
* Add support for Google Analytics to theme.

This setting has actually existed in the default config since the original version,
but doesn't currently work.
This fixes that and supports GA if it's set.

* Add docs around analytics_id

* Do not conflict with RTD insertion of analytics script

* Remove dupliate analytics_id

* Add analytics_id to the configuration in its new place
2018-12-04 15:08:29 -05:00
Anthony Johnson
31b7c3b46a Much cleanup for configuration docs
* Clean up a lot of copy.
  * Reduce usage of internal Sphinx concepts like "toctree"
  * Make language clearer
  * Fix a few factual inaccuracies
  * Remove noisey/placeholder/introduction to a paragraph sort of text,
    this just distracts readers.
* Make `confval` domain role to allow for creation of config value field
  lists that are linkable and can be referenced. Also include
  type/default fields
* Reduce redundancy in heading
* Intersphinx to Sphinx docs
* Use new role to intersphinx to Sphinx confvals
* Add copy on using logo/etc. These are common questions for us for
  those not familiar with Sphinx. Link to appropriate docs.
2018-09-26 14:35:45 -06:00
Aaron Carlisle
7cd846b4fd Docs: correct navigation_depth discription (#609)
* Docs: correct navigation_depth discription

* Docs: add note about large toctrees

* Docs: Cleanup: use different note markup

Github does not mark the syntax correctly otherwise
2018-04-11 22:04:32 -04:00
ederag
60fff9cbeb add missing quotes (bottom should be a string) (#580) 2018-02-20 14:48:48 -05:00
jpsenior
04520a0476 #463 - Add github, gitlab, bitbucket page arguments option (#464)
This currently defaults to current behavior but can be changed with `vcs_pageview_mode`
2018-01-31 21:46:14 -05:00
Aaron Carlisle
1e6e1049a1 Remove from docs 2018-01-30 15:08:38 -05:00
Aaron Carlisle
67bb54d450 Refactor docs: split up & slim down read me
Fixes #557 #523

* Remove old conf file setup

* Split changelog to its ownfile

* Remove changelog from readme

* Update introduction sentence

* Fix wording of intro

* Remove readme table of contents

* Move links to there sections

* Remove config

* Create configuring.rst

* Remove todo

* Remove installing docs from readme

* Create installing.rst

* Remove contributing section from readme

* Create contributing.rst

* Include basic info in readme

The rest gets pointed to our actual docs

* Add new files to toctree

* Fix configuring options title

* Set logo_only to True

  Also, remove documentation of theme options. We have actual docs for this.

* Include readme on index page
2018-01-29 20:44:03 -05:00