Data

Tools

Indexes

Applications

Experiments

Open Source Science

CMinx

CMinx: A CMake Documentation Generator - Published in JOSS (2022)

https://github.com/cmakepp/cminx

Science Score: 98.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ✓
    DOI references
    Found 4 DOI reference(s) in README and JOSS metadata
  • ✓
    Academic publication links
    Links to: joss.theoj.org
  • ○
    Committers with academic emails
  • ○
    Institutional organization owner
  • ✓
    JOSS paper metadata
    Published in Journal of Open Source Software

Keywords

cmake documentation-tool

Keywords from Contributors

object-oriented-programming
Last synced: 6 months ago · JSON representation ·

Repository

Generates API documentation for CMake functions and macros

Basic Info
Statistics
  • Stars: 14
  • Watchers: 5
  • Forks: 7
  • Open Issues: 14
  • Releases: 1
Topics
cmake documentation-tool
Created over 6 years ago · Last pushed 7 months ago
Metadata Files
Readme License Citation

README.rst 

..
   Copyright 2021 CMakePP

   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
   You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.

#####
CMinx
#####

.. image:: https://codecov.io/gh/CMakePP/CMinx/branch/master/graph/badge.svg?token=wbiPq8Gnrs
   :target: https://codecov.io/gh/CMakePP/CMinx

.. image:: https://joss.theoj.org/papers/10.21105/joss.04680/status.svg
   :target: https://doi.org/10.21105/joss.04680


Full documentation can be found `here `__.

*****************
Statement of Need
*****************

CMake build systems can be extended by writing CMake modules. CMake modules
typically consist of one or more functions (or macros) written in the CMake
language. In an effort to treat infrastructure as code, we need to be able to
generate API documentation for these CMake modules. CMinx addresses this need
by generating reStructuredText files from documented CMake modules. Since CMinx
understands the grammar of the CMake language, these comments only need to focus
on describing the code and not duplicating it.

*************************
Installation Instructions
*************************

The easiest way to install CMinx is via ``pip``. Simply run:

.. code:: .py

   pip install CMinx


CMinx can also easily be used as part of a CMake workflow by adding:

.. code-block:: cmake

   include(FetchContent)
   FetchContent_Declare(
       cminx
       GIT_REPOSITORY https://github.com/cmakepp/cminx.git
   )
   FetchContent_MakeAvailable(cminx)
   cminx_gen_rst("${input_dir}" "${output_dir}")

to your ``CMakeLists.txt`` file. More detailed instructions, can be found
`here `__.


*************
Example Usage
*************

To use CMinx, first document your CMake modules like:

.. code:: cmake

   #[[[
   # A brief description.
   #
   # A more detailed description, must be separated from the brief by at least
   # one blank line.
   #
   # :param param0: The 0-th parameter passed to the function
   #]]
   function(example param0)
       message("This function says: ${param0}")
   endfunction()

The documentation resides in a normal CMake block comment aside from the fact
that the block comment starts with an extra ``[`` character. The body of the
block comment is extracted into the reStructuredText file more or less verbatim
so reStructuredText markup can be used within the comment for more formatting
options. Assuming the above CMake module lives in ``example.cmake``, the
API documentation is generated by running:

.. code:: console

   foo@bar:~$ cminx example.cmake

Which will generate:

.. code:: reStructuredText

   #######
   example
   #######

   .. module:: example


   .. function:: example(param0)

      A brief description.

      A more detailed description, must be separated from the brief by at least
      one blank line.

      :param param0: The 0-th parameter passed to the function

See `here `__ for more
detailed usage instructions.


*****************
API Documentation
*****************

Full API documentation can be found
`here `__.

************
Contributing
************

In short, we try to be a welcoming community. If you have questions,
suggestions, bug reports, *etc.* open an issue and we will address them
as soon as possible. If you want to contribute code, that's even better. We
recommend you start a draft PR early in the process so we know the contribution
is coming and can help you along the way.

CMinx is part of the CMakePP organization, whose contributing guidelines can be
found `here `__.

Owner

  • Name: CMakePP
  • Login: CMakePP
  • Kind: organization

Dedicated to making packaging projects with CMake eaiser

JOSS Publication

CMinx: A CMake Documentation Generator
Published
September 27, 2022
DOI
Volume 7, Issue 77, Page 4680
Authors
Branden Butler
Ames National Laboratory, Ames, IA, USA, Iowa State University, Ames, IA, USA
Ryan M. Richard ORCID
Ames National Laboratory, Ames, IA, USA, Iowa State University, Ames, IA, USA
Editor
Daniel S. Katz ORCID
Tags
CMake Documentation
View PDF Review Thread Software Archive

Citation (CITATION.cff) 

cff-version: "1.2.0"
authors:
- family-names: Butler
  given-names: Branden
- family-names: Richard
  given-names: Ryan M.
  orcid: "https://orcid.org/0000-0003-4235-5179"
contact:
- family-names: Richard
  given-names: Ryan M.
  orcid: "https://orcid.org/0000-0003-4235-5179"
doi: 10.5281/zenodo.7116601
message: If you use this software, please cite our article in the
  Journal of Open Source Software.
preferred-citation:
  authors:
  - family-names: Butler
    given-names: Branden
  - family-names: Richard
    given-names: Ryan M.
    orcid: "https://orcid.org/0000-0003-4235-5179"
  date-published: 2022-09-23
  doi: 10.21105/joss.04680
  issn: 2475-9066
  issue: 77
  journal: Journal of Open Source Software
  publisher:
    name: Open Journals
  start: 4680
  title: "CMinx: A CMake Documentation Generator"
  type: article
  url: "https://joss.theoj.org/papers/10.21105/joss.04680"
  volume: 7
title: "CMinx: A CMake Documentation Generator"

GitHub Events

Total
  • Issues event: 6
  • Issue comment event: 16
  • Push event: 2
  • Pull request review event: 9
  • Pull request review comment event: 7
  • Pull request event: 4
  • Fork event: 2
  • Create event: 1
Last Year
  • Issues event: 6
  • Issue comment event: 16
  • Push event: 2
  • Pull request review event: 9
  • Pull request review comment event: 7
  • Pull request event: 4
  • Fork event: 2
  • Create event: 1

Committers

Last synced: 7 months ago

All Time
  • Total Commits: 195
  • Total Committers: 6
  • Avg Commits per committer: 32.5
  • Development Distribution Score (DDS): 0.385
Past Year
  • Commits: 2
  • Committers: 2
  • Avg Commits per committer: 1.0
  • Development Distribution Score (DDS): 0.5
Top Committers
Name Email Commits
Branden Butler b****r@h****m 120
Ryan Richard r****1@g****m 69
ni-fgenois 6****s 2
Roberto Di Remigio r****r 2
Zachery Crandall z****n@g****m 1
René Fritze 4****e 1

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 45
  • Total pull requests: 66
  • Average time to close issues: 22 days
  • Average time to close pull requests: 7 days
  • Total issue authors: 9
  • Total pull request authors: 8
  • Average comments per issue: 2.58
  • Average comments per pull request: 2.86
  • Merged pull requests: 56
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 9
  • Pull requests: 4
  • Average time to close issues: 9 days
  • Average time to close pull requests: 5 days
  • Issue authors: 1
  • Pull request authors: 1
  • Average comments per issue: 0.0
  • Average comments per pull request: 7.25
  • Merged pull requests: 1
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • ryanmrichard (11)
  • AutonomicPerfectionist (10)
  • zachcran (10)
  • peanutfun (5)
  • robertodr (3)
  • dschiller (3)
  • tobiasleibner (1)
  • flagarde (1)
  • ni-dschiller (1)
Pull Request Authors
  • ryanmrichard (35)
  • AutonomicPerfectionist (20)
  • renefritze (6)
  • robertodr (2)
  • ni-fgenois (2)
  • JackNoordhuis (1)
  • zachcran (1)
  • danielskatz (1)
Top Labels
Issue Labels
enhancement (22) bug (10) question (5) documentation (1)
Pull Request Labels
bump:minor (3) documentation (2) bump:major (1)

Packages

  • Total packages: 2
  • Total downloads:
    • pypi 5,252 last-month
  • Total dependent packages: 0
    (may contain duplicates)
  • Total dependent repositories: 1
    (may contain duplicates)
  • Total versions: 10
  • Total maintainers: 1
pypi.org: cminx

Documentation Generator for the CMake Language

  • Documentation: https://cminx.readthedocs.io/
  • License: Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
  • Latest release: 1.1.12
    published 7 months ago
  • Versions: 9
  • Dependent Packages: 0
  • Dependent Repositories: 1
  • Downloads: 5,252 Last month
Rankings
Dependent packages count: 10.1%
Average: 18.9%
Dependent repos count: 21.6%
Downloads: 25.0%
Maintainers (1)
ryanmrichard
Last synced: 6 months ago
pypi.org: cminxtestingpackage

Documentation Generator for the CMake Language

  • Versions: 1
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 0
Rankings
Dependent packages count: 4.8%
Dependent repos count: 6.3%
Forks count: 13.4%
Average: 19.8%
Stargazers count: 24.3%
Downloads: 50.4%
Last synced: 11 months ago

Dependencies

.github/workflows/cmake_install.yaml actions
  • actions/checkout v1 composite
  • actions/setup-python v4 composite
  • lukka/get-cmake v3.20.1 composite
.github/workflows/deploy_docs.yaml actions
  • actions/checkout v2 composite
  • actions/setup-python v4 composite
  • peaceiris/actions-gh-pages v3 composite
.github/workflows/format_python.yaml actions
  • EndBug/add-and-commit v4 composite
  • actions/checkout v2 composite
  • peter-evans/autopep8 v1 composite
.github/workflows/pip_install.yaml actions
  • actions/checkout v2 composite
  • actions/setup-python v4 composite
  • codecov/codecov-action v2 composite
.github/workflows/test_pip_install.yaml actions
  • actions/checkout v2 composite
docs/requirements.txt pypi
  • sphinx *
  • sphinx_rtd_theme *
.github/workflows/add_licenses.yaml actions
.github/workflows/tag_and_release.yaml actions
pyproject.toml pypi
  • antlr4-python3-runtime ==4.7.2
  • confuse >=1.7
  • pathspec >=0.9.0
setup.py pypi