Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

More documentation updates for 3.11.0 #3553

Merged
merged 20 commits into from
Jul 31, 2022

Conversation

falbrechtskirchinger
Copy link
Contributor

@falbrechtskirchinger falbrechtskirchinger commented Jun 23, 2022

mkdocs

  • Add string_view examples.
  • Add operator<=> examples.
  • Rename some examples, following a consistent scheme: <function> _ _ <parameter type> [_ const]
  • Fix some style check issues: missing admonition titles, line length, missing sections, ...
  • Review BJData page and edit slightly.
  • Add CMake option hint to macro pages.

docset

  • Add/update all macros with up-to-date URLs.
  • Add missing operators and mirror order from mkdocs.
  • Other additions: object_comparator_t, BJData, "Arbitrary Type Conversions", ...
  • Add list_missing_pages make target. Prints the list of mkdocs pages missing from the docset index.
  • Add list_removed_paths make target. Prints the list of paths in the docset index without a matching mkdocs page.
  • Add install_docset_zeal make target (https://zealdocs.org/). (That's the documentation browser I'm using.)

To Do

@coveralls
Copy link

coveralls commented Jun 23, 2022

Coverage Status

Coverage remained the same at 100.0% when pulling 3cb9731 on falbrechtskirchinger:documentation into 11ba5c1 on nlohmann:develop.

@falbrechtskirchinger
Copy link
Contributor Author

The test timeout issue is not fixed and, thanks to the debug commit, I understand why. I thought I was being clever by resetting the test timeout based on the xxxx of yyyy UTF-8 strings checked output – turns out, that the CMake test property TIMEOUT_AFTER_MATCH is only applied once. Guess I'll add another mini-PR to the pile, that just raises the TIMEOUT property to … twice the default.

@falbrechtskirchinger
Copy link
Contributor Author

@nlohmann This PR depends on #3590 (mkdocs-redirects) and needs a few more changes (docset index, redirects map), but is otherwise done.

@nlohmann
Copy link
Owner

@nlohmann This PR depends on #3590 (mkdocs-redirects) and needs a few more changes (docset index, redirects map), but is otherwise done.

#3590 is merged now.

@falbrechtskirchinger
Copy link
Contributor Author

I'll double-check things tomorrow but I believe this one's complete now. docset should be on par with mkdocs.

@nlohmann
Copy link
Owner

Sigh - we need some mechanism to compile some examples with higher C++ versions. Quick idea: encode the version in the file name.

@falbrechtskirchinger
Copy link
Contributor Author

Yeah, I don't have a better idea for now. On it (after I grab some coffee :-)).

@falbrechtskirchinger
Copy link
Contributor Author

For the record:

mkdocs: move string literals bbcf4c1

.gitignore Outdated Show resolved Hide resolved
docs/docset/Makefile Outdated Show resolved Hide resolved
@@ -1,24 +1,82 @@
JSON_for_Modern_C++.docset: Info.plist docSet.sql
$(MAKE) clean
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Undo.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nope. This line has to go. clean removes docSet.dsidx.

docs/docset/Makefile Show resolved Hide resolved
docs/docset/Makefile Show resolved Hide resolved
docs/docset/Makefile Show resolved Hide resolved
Copy link
Owner

@nlohmann nlohmann left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me.

@falbrechtskirchinger
Copy link
Contributor Author

Hold. Hold. Hold.

Checking on one last issue.

@falbrechtskirchinger
Copy link
Contributor Author

All good.

@nlohmann nlohmann merged commit d3e347b into nlohmann:develop Jul 31, 2022
@falbrechtskirchinger falbrechtskirchinger deleted the documentation branch July 31, 2022 12:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants