KEMBAR78
More documentation updates for 3.11.0 by falbrechtskirchinger · Pull Request #3553 · nlohmann/json · GitHub
Skip to content

More documentation updates for 3.11.0 #3553

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 20 commits into from
Jul 31, 2022
Merged

More documentation updates for 3.11.0 #3553

merged 20 commits into from
Jul 31, 2022

Conversation

falbrechtskirchinger
Copy link
Contributor

@falbrechtskirchinger falbrechtskirchinger commented Jun 23, 2022 •
edited
Loading

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 •
edited
Loading

Coverage Status

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

gregmarr
gregmarr reviewed Jun 23, 2022
View reviewed changes
nlohmann
nlohmann reviewed Jul 4, 2022
View reviewed changes
@falbrechtskirchinger falbrechtskirchinger marked this pull request as ready for review July 17, 2022 15:40
@nlohmann nlohmann added this to the Release 3.11.0 milestone Jul 23, 2022
@falbrechtskirchinger falbrechtskirchinger mentioned this pull request Jul 25, 2022
Merged
@falbrechtskirchinger falbrechtskirchinger marked this pull request as draft July 25, 2022 20:20
@falbrechtskirchinger falbrechtskirchinger force-pushed the documentation branch 4 times, most recently from c324988 to 485917d Compare July 26, 2022 16:44
@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 falbrechtskirchinger marked this pull request as ready for review July 28, 2022 20:33
@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

falbrechtskirchinger
falbrechtskirchinger commented Jul 31, 2022
View reviewed changes
docs/docset/Makefile
@@ -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.

nlohmann
nlohmann reviewed Jul 31, 2022
View reviewed changes
nlohmann
nlohmann reviewed Jul 31, 2022
View reviewed changes
nlohmann
nlohmann approved these changes Jul 31, 2022
View reviewed changes
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.

@nlohmann nlohmann self-assigned this Jul 31, 2022
@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

Reviewers

@nlohmann nlohmann nlohmann approved these changes

+1 more reviewer

@gregmarr gregmarr gregmarr left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

@nlohmann nlohmann

Labels

release item: 🔨 further change

Projects

None yet

Milestone

Release 3.11.0

Development

Successfully merging this pull request may close these issues.

4 participants

@falbrechtskirchinger @coveralls @nlohmann @gregmarr