Cargo 子命令，用于构建和发布 Sphinx 文档。支持发布到 GitHub Pages。

详细文档在 docs 目录以及 woofwoofinc.github.io/cargo-sphinx 中提供。

Cargo Sphinx最初由Ning Sun从cargo-release项目分支而来。

安装

使用以下命令在 Git 管理的基于 Cargo 的 Rust 项目中安装 Cargo Sphinx：

$ cargo install cargo-sphinx

使用以下命令构建项目的 Sphinx 文档：

$ cargo sphinx

要同时将文档推送到 GitHub Pages 分支，包括 --push 选项

$ cargo sphinx --push

这将生成 Sphinx 文档并将其提交到存储库的 gh-pages 分支。如果已启用存储库上的 GitHub Pages，那么您可以在 https://YOUR-GITHUB-USERNAME.github.io/YOUR-REPOSITORY-NAME 上查看您的文档。

警告：这将覆盖您现有的 gh-pages 分支，请自行承担风险。

包括 --dry-run 选项以打印要执行的命令，而不是执行生成和上传。

开发

项目构建栈使用 Rust 开发工具。如果它们不可用，请使用 rustup 在您的系统上安装这些工具。

项目仓库中包含一个 rkt 容器构建脚本，提供了一个可以用于构建项目的安装程序。有关更多信息，请参阅文档中开发工具容器部分的构建和运行容器的描述。

针对macOS，RktMachine提供了一个支持使用rkt容器系统的CoreOS VM。

使用以下命令构建和测试项目：

$ cargo test

使用以下命令从最新源代码安装插件的开发版本：

$ cargo install --path .

(--force如果已安装Cargo Sphinx，则必需。)

然后进行dry run测试

$ cargo sphinx --push --dry-run

如果您想帮助扩展和改进此项目，则您的贡献将非常受欢迎。查看我们的GitHub issues获取想法或提问的地方。欢迎加入我们的团队！

许可证

本作品同时受Apache License，版本2.0和MIT许可证的许可。

您可以选择在Apache License，版本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://apache.ac.cn/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.

或者，您可以按照您的选择在MIT许可证下许可此项工作。

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.

选择许可证网站上的许可证说明可能很有帮助。它们对Apache 2.0许可证和MIT许可证条件都有描述。

贡献

请注意，本项目遵循贡献者行为准则。通过参与本项目，您同意遵守其条款。滥用、骚扰或其他不可接受的行为可通过联系项目团队[email protected]进行报告。

除非您明确表示，否则根据Apache-2.0许可证定义的，您有意提交给作品包含的贡献将如上所述双许可，不附加任何额外条款或条件。