Cargo subcommand for building and publishing Sphinx documentation. Includes support for publishing to GitHub Pages.

Detailed documentation is provided in the docs directories and at woofwoofinc.github.io/cargo-sphinx.

Cargo Sphinx was originally forked from the cargo-release project by Ning Sun.

Installing

Install Cargo Sphinx in a Git managed Cargo-based Rust project using:

$ cargo install cargo-sphinx

Build the project Sphinx documentation using:

$ cargo sphinx

To also push the documentation to the GitHub Pages branch include the --push option:

$ cargo sphinx --push

This will generate Sphinx documentation and commit it to the gh-pages branch of the repository. If GitHub Pages are enabled on the repository then you will be able to view your documentation at https://YOUR-GITHUB-USERNAME.github.io/YOUR-REPOSITORY-NAME.

WARNING: This will override your existing gh-pages branch, use at your own risk.

Include the --dry-run option to print all the commands to execute instead of performing the generate and upload.

Developing

The project build stack uses the Rust development tools. Install these on your system with rustup if they are not already available.

A rkt container build script is included in the project repository and provides an installation which can be used to build the project also. See the description on building and running the container in the Development Tools Container section of the documentation for more information.

For macOS, RktMachine provides a CoreOS VM which supports developing using the rkt container system.

Build and test the project using:

$ cargo test

Install a development version of the plugin locally from latest source using:

$ cargo install --path .

(--force is necessary if Cargo Sphinx is already installed.)

Then test with a dry run:

$ cargo sphinx --push --dry-run

If you want to help extend and improve this project, then your contributions would be greatly appreciated. Check out our GitHub issues for ideas or a place to ask questions. Welcome to the team!

License

This work is dual-licensed under the Apache License, Version 2.0 and under the MIT Licence.

You may license this work under the Apache License, Version 2.0.

Copyright 2020 Ning Sun, tojson_macros contributors, and Woof Woof, Inc. contributors

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.

Alternatively, you may license this work under the MIT Licence at your option.

Copyright (c) Ning Sun, tojson_macros contributors, and Woof Woof, Inc. contributors

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

The license explainers at Choose a License may be helpful. They have descriptions for both the Apache 2.0 Licence and MIT Licence conditions.

Contributing

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms. Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at woofwoofinc@gmail.com.

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.