Commit Graph

13 Commits

Author SHA1 Message Date
oleibman d12232529b Twear DarkImages Bookmarklet
It should always work on first try now. Previously, it needed to be executed twice under some circumstances.
2026-09-20 16:29:06 -07:00
oleibman d13f34b84e More Documentation Tweaks
Special handling in javascript and css for any image whose `alt` value starts with `Logo`, rather than targeting one specific value.

Remove 2 no-longer relevant statements from `extra.css`.

Add css member for `mkdocs` theme.

Add link to PhpSpreadsheet site to the bottom line of each page for `readthedocs` and `mkdocs` themes. In theory, these links should already exist, and they do locally, but not, for some reason, when run on readthedocs.io. This link is different from the `Edit on Github` link at the top, which is a kind of interesting feature.

Add a bookmarklet on the main page for toggling images to dark mode, which would probably be the preference for users employing dark mode. Images are usually left unchanged in dark mode, but almost all our images are screenshots, and dark mode might be appropriate for them.
2026-09-19 19:57:45 -07:00
oleibman 2ad3b70018 Minor Documentation Tweaks
`extra.css` specifies a background color for `td` and `th`. I believe it is used only for the `readthedocs` theme, and I do not see why it is needed there; it slightly interferes with dark mode. Comment it out rather than deleting it, just in case a need is established for it.

Color the top bar for `zensical`.

`mkdocs` theme has a weird problem described in its yml file. There is a workaround, but I'm not comitted to it, so make it available but don't use it yet.
2026-09-17 08:00:51 -07:00
oleibman 284aff8d40 More Tweaks
Use a white, rather than transparent, background for logo, making it viewable in dark mode.

A bit better emulation of dark mode in the readthedocs theme, which does not handle it "naturally".
2026-09-01 16:51:23 -07:00
oleibman d4ebbe9a59 Logo Displayed Poorly in Dark Mode 2026-08-31 22:50:46 -07:00
oleibman c5898ac9cd Better Syntax Highlighting in Zensical/Material 2026-08-30 21:05:24 -07:00
oleibman 882f8c63d7 More Doc Updates 2026-08-26 22:56:33 -07:00
oleibman 001c557f1c Readthedocs Theme - Support Dark/Light Preference Without Toggle 2026-08-24 21:02:33 -07:00
oleibman 2319124ff6 WIP Docs Experiment with Properdocs and Copy Clipboard
Experiment with Properdocs as a substitute for the troubled Mkdocs package. Alternate approach to PR #4971.

Also add javascript for copy-to-clipboard functionality for readthedocs and mkdocs themes. A little less aesthetic than material themes, but it should work.

Still unable to add dark mode to readthedocs theme.
2026-08-23 20:33:34 -07:00
oleibman 0cd725d000 Automate Function-by-Name and Function-by-Category Docs (#3818)
* Automate Function-by-Name and Function-by-Category Docs

Examining whether it is possible to analyze the 2 Php scripts in the bin directory even though they lack a .php extension, I found that the docs generated by `generate-document` had not been updated in over a year even though support for a number of functions (e.g. ARRAYTOTEXT) had long ago been implemented. The files generated by the other script `generate-locales` are automatically generated as part of the unit test suite, and I can't see any reason not to do the same for `generate-document`.

It isn't totally clear that the 2 scripts in bin are needed any more now that each has an equivalent in the unit test suite. For now, I'm keeping them, and allowing them to be analyzed by phpcs, php-cs-fixer, and phpstan.

* Reflection Not Required

Remove it from bin scripts and DocumentGeneratorTest.

* Better Html/Css Display for Function Lists

* Redesign Features Cross Reference Doc

It was inaccurate, and pretty much impossible to read in entirety. This version should be easier to read, and to correct. That's important, because there are almost certainly new inaccuracies in this version.

* Add Html to Features Cross-Reference Readers
2023-12-11 07:38:13 -08:00
oleibman 10c9c4cf23 Make Documentation Updates Easier and More Accurate (#1573)
I made a documentation change and noticed that the result when browsed
locally did not quite match what is seen when browsing from the web.
After some research, I found https://github.com/mkdocs/mkdocs/issues/2028
That described my situation well and suggested adding an extra
javascript script to the configuration. This worked exactly as desired
on my local machine. This accounts for the presence of extrajs.js
and mkdocs.yml in this request.

In addition to the display problem, "mkdocs build" generates the
documentation into a directory which is not ignored by git. I added
that directory to .gitignore as part of this request.

Finally, since I don't know how exactly the documentation makes it
to production, I made an insignificant change to one doc file as
a sanity check.
2021-02-15 20:50:20 +01:00
Adrien Crivelli 22d5312be8 Remove extra js in docs
Since the release of Read the Docs 2.5 this is no longer required
and it broke version selector.
2018-06-08 12:15:24 +09:00
Adrien Crivelli 5df66809bc Workaround for RTD search
For details, see https://github.com/rtfd/readthedocs.org/issues/1487

FIX #153
2017-05-05 11:56:18 +02:00