Commit graph

24 commits

Author SHA1 Message Date
0072289c4e Explicitly tell myst to accept internal links to multiple levels of headings
Some dumb change requires this to be explicit now.
2024-04-02 02:25:21 -04:00
3cb64ae3d9 Replace HTML theme options url with main conf.py setting 2024-04-02 02:24:24 -04:00
c8d6382412 Update copyright to current year, use full co-op name, include Chris 2024-04-02 00:08:46 -04:00
89ebc2995b Update for Sphinx 5.3 based on warnings
$ sphinx-build -b html . _build/html
Running Sphinx v5.3.0
WARNING: Invalid configuration value found: 'language = None'. Update your configuration to a valid language code. Falling back to 'en' (English).
WARNING: The canonical_url option is deprecated, use the html_baseurl option from Sphinx instead.
2024-04-02 00:07:43 -04:00
d61f414387 Fix gitlab links to documentation 2023-09-25 18:53:11 -04:00
92c9cb77a6 Update copyright year 2022-05-03 00:36:51 -04:00
92a80fa5c9 Try adding explicit mention of sphinx rtd theme
Per https://stackoverflow.com/questions/67542699/readthedocs-sphinx-not-rendering-bullet-list-from-rst-file
2022-02-09 23:38:37 -05:00
benjamin melançon
42c94770ff Update year in copyright... huh this needs to be a copyleft 2021-04-24 20:26:31 -04:00
benjamin melançon
ab2b237304 Add custom logo and custom styles 2020-07-02 01:15:51 -04:00
benjamin melançon
b65293176e Switch to the Sphinx RTD theme (better TOC, better GitLab link, no weird versions thing) 2020-07-01 21:17:27 -04:00
benjamin melançon
5b59bb8b57 Stop importing the CommonMark parser that we don't use anymore! 2020-07-01 21:16:44 -04:00
benjamin melançon
01d74994bc Switch from recommonmark to MyST parser for Sphinx 2020-06-02 10:47:10 -04:00
benjamin melançon
80569c6037 Add MyST markdown to be able to do admonitions (notes)
Thanks to https://github.com/readthedocs/recommonmark/issues/189#issuecomment-637440853
comment by chrisjsewell
2020-06-02 10:01:16 -04:00
benjamin melançon
31c39db060 Nope it's probably source parsers that's obsoleted by autodoc 2020-03-23 13:53:59 -04:00
benjamin melançon
04f8a49ac6 Try commenting out thing recommonmark's conf.py doesn't have
Trying to avoid this error:

 Running Sphinx v1.8.5
loading translations [en]... done
making output directory...

Traceback (most recent call last):
  File "/home/docs/checkouts/readthedocs.org/user_builds/agaric-documentation/envs/latest/lib/python2.7/site-packages/sphinx/cmd/build.py", line 303, in build_main
    args.tags, args.verbosity, args.jobs, args.keep_going)
  File "/home/docs/checkouts/readthedocs.org/user_builds/agaric-documentation/envs/latest/lib/python2.7/site-packages/sphinx/application.py", line 251, in __init__
    self.emit('config-inited', self.config)
  File "/home/docs/checkouts/readthedocs.org/user_builds/agaric-documentation/envs/latest/lib/python2.7/site-packages/sphinx/application.py", line 510, in emit
    return self.events.emit(event, self, *args)
  File "/home/docs/checkouts/readthedocs.org/user_builds/agaric-documentation/envs/latest/lib/python2.7/site-packages/sphinx/events.py", line 80, in emit
    results.append(callback(*args))
  File "/home/docs/checkouts/readthedocs.org/user_builds/agaric-documentation/envs/latest/lib/python2.7/site-packages/sphinx/util/compat.py", line 38, in deprecate_source_parsers
    app.add_source_parser(suffix, parser)
  File "/home/docs/checkouts/readthedocs.org/user_builds/agaric-documentation/envs/latest/lib/python2.7/site-packages/sphinx/application.py", line 1211, in add_source_parser
    self.registry.add_source_parser(*args, **kwargs)
  File "/home/docs/checkouts/readthedocs.org/user_builds/agaric-documentation/envs/latest/lib/python2.7/site-packages/sphinx/registry.py", line 310, in add_source_parser
    filetype)
ExtensionError: source_parser for 'md' is already registered

Extension error:
source_parser for 'md' is already registered
2020-03-23 13:49:38 -04:00
benjamin melançon
8d001ad2b1 Add options enabled in recommonmark repository
That powers https://recommonmark.readthedocs.io/en/latest/index.html
2020-03-23 13:38:54 -04:00
benjamin melançon
ef376e3dcd Try removing deprecated option even set to false 2020-03-23 13:19:54 -04:00
benjamin melançon
37d185ad01 Update our copyright date 2020-03-23 12:27:26 -04:00
benjamin melançon
1f863190f7 Add Edit on GitLab links 2018-09-05 19:37:44 -04:00
benjamin melançon
a4f34252a5 Add and configure recommonmark 2018-07-22 11:55:35 -04:00
Benjamin Melançon
2e73eccd41 Stick with *project* name
(it is assumed to be documentation for a project, so having documentation
in the project name is redundant for sphinx)
2018-06-17 17:18:26 -04:00
Benjamin Melançon
2174974088 Completed config file 2018-06-17 17:16:44 -04:00
Benjamin Melançon
360adab97f Update (largely replace with new sphinx-quickstart) config file 2018-06-17 16:25:25 -04:00
Benjamin Melançon
c7831ee138 Initial commit
Modified copy of Drutopia sphinx conf file (for Read the Docs)
2018-06-17 15:31:55 -04:00