sphinx-ultra 0.3.0

High-performance Rust-based Sphinx documentation builder for large codebases
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121

# Contributing to Sphinx Ultra

We love your input! We want to make contributing to Sphinx Ultra as easy and transparent as possible, whether it's:

- Reporting a bug
- Discussing the current state of the code
- Submitting a fix
- Proposing new features
- Becoming a maintainer

## Development Process

We use GitHub to host code, to track issues and feature requests, as well as accept pull requests.

## Pull Requests

Pull requests are the best way to propose changes to the codebase. We actively welcome your pull requests:

1. Fork the repo and create your branch from `main`.
2. If you've added code that should be tested, add tests.
3. If you've changed APIs, update the documentation.
4. Ensure the test suite passes.
5. Make sure your code lints.
6. Issue that pull request!

## Development Setup

### Prerequisites

- Rust 1.70 or higher
- Git

### Setup

1. Clone the repository:
   ```bash
   git clone https://github.com/salioglu/sphinx-ultra.git
   cd sphinx-ultra
   ```

2. Build the project:
   ```bash
   ./build.sh
   ```

3. Run tests:
   ```bash
   cargo test
   ```

4. Run benchmarks:
   ```bash
   cargo bench
   ```

## Code Style

We use the standard Rust formatting and linting tools:

- **Formatting**: `cargo fmt`
- **Linting**: `cargo clippy`

Please run these before submitting your pull request.

## Testing

We aim for high test coverage. When adding new features:

1. Add unit tests for individual functions
2. Add integration tests for major workflows
3. Add benchmarks for performance-critical code

Run the full test suite with:
```bash
cargo test --all
```

## Performance Considerations

Sphinx Ultra is built for performance. When contributing:

- Profile your changes with `cargo bench`
- Consider memory usage and allocations
- Use `rayon` for parallelization where appropriate
- Leverage the caching system for expensive operations

## Documentation

- Keep the README.md updated with any new features
- Add inline documentation for public APIs
- Update examples if you change functionality

## Reporting Bugs

We use GitHub issues to track public bugs. Report a bug by [opening a new issue](https://github.com/salioglu/sphinx-ultra/issues).

**Great Bug Reports** tend to have:

- A quick summary and/or background
- Steps to reproduce
  - Be specific!
  - Give sample code if you can
- What you expected would happen
- What actually happens
- Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)

## Feature Requests

We love feature requests! Please [open an issue](https://github.com/salioglu/sphinx-ultra/issues) with:

- Clear description of the feature
- Why you want this feature (use case)
- How it should work (if you have ideas)

## License

By contributing, you agree that your contributions will be licensed under the MIT License.

## References

This document was adapted from the open-source contribution guidelines for [Facebook's Draft](https://github.com/facebook/draft-js/blob/a9316a723f9e918afde44dea68b5f9f39b7d9b00/CONTRIBUTING.md).