Skip to content

Commit 4726bfd

Browse files
authored
docs: DocFX v2 upgrade with organized API landing page (#564)
## Summary DocFX v2 upgrade with comprehensive documentation restructure: ### Documentation Pages - **API Reference**: Custom landing page organized by functionality (not alphabetical) - **NumPy Compliance & Compatibility**: Compliance goals, NEP tracking, roadmap - **Array API Standard**: Full specification coverage, function matrices - **Broadcasting**: Rules, shape compatibility, API reference - **Extending Libraries**: NumSharp.Bitmap documentation ### Structure - Custom `api/toc.yml` with categorized sidebar - `docs/website-src/` for source, `docs/website/` for output - Fixed README image paths ### Issue Closes #563
1 parent fd029a2 commit 4726bfd

File tree

348 files changed

+176857
-4890
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

348 files changed

+176857
-4890
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
[![NumSharp](docs/images/numsharp.logo.png)](docs/images/numsharp.logo.png)
1+
[![NumSharp](docs/website/images/numsharp.logo.png)](docs/website/images/numsharp.logo.png)
22

33
[![NuGet](https://img.shields.io/nuget/dt/NumSharp.svg)](https://www.nuget.org/packages/NumSharp)
44
[![Join the chat at https://gitter.im/publiclab/publiclab](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/sci-sharp/community)
@@ -13,7 +13,7 @@ Is it difficult to translate python machine learning code into .NET? Because too
1313
NumSharp is the C# version of NumPy, which is as consistent as possible with the NumPy programming interface, including function names and parameter locations. By introducing the NumSharp tool library, you can easily convert from python code to C# or F# code.
1414
Here is a comparison code between NumSharp and NumPy (left is python, right is C#):
1515

16-
[![comparision](docfx_project/images/python-csharp-comparision.png)](https://raw.githubusercontent.com/SciSharp/NumSharp/master/docfx_project/images/python-csharp-comparision.png)
16+
[![comparision](docs/website/images/python-csharp-comparision.png)](https://raw.githubusercontent.com/SciSharp/NumSharp/master/docs/website/images/python-csharp-comparision.png)
1717

1818
### Bold Features
1919
* Use of Unmanaged Memory and fast unsafe algorithms.

docs/website-src/api/.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
###############
22
# temp file #
33
###############
4+
# Generated API YAML files (except toc.yml which we customize)
45
*.yml
6+
!toc.yml
57
.manifest

0 commit comments

Comments
 (0)