Skip to content

Commit 6cbd394

Browse files
authored
Remove leftover Sphinx reference and URLs (#2088)
1 parent 1bdcdaa commit 6cbd394

File tree

5 files changed

+7
-11
lines changed

5 files changed

+7
-11
lines changed

.github/CONTRIBUTING.md

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,5 @@
11
## Contributing
22

33
To edit the documentation pages displayed at
4-
[conda-forge.org/docs/][conda-forge-docs], please edit the source
5-
[reStructuredText][] files in `sphinx/src/`.
6-
7-
[conda-forge-docs]: https://conda-forge.org/docs/
8-
[reStructuredText]: http://docutils.sourceforge.net/rst.html
4+
[conda-forge.org/docs/][https://conda-forge.org/docs/], please edit the source
5+
Markdown files in `docs/`.

docs/maintainer/infrastructure.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ Please open a [PR](../misc/index.md#term-PR) and/or an issue there, if you think
6363

6464
The documentation website lives in [conda-forge/conda-forge.github.io](https://github.com/conda-forge/conda-forge.github.io/), and is automatically deployed to our [online version](https://conda-forge.org/).
6565

66-
The documentation is built with `Sphinx` and the sources files are located in the [src](https://github.com/conda-forge/conda-forge.github.io/tree/main/sphinx/src) directory of the repository. These are then rendered to Markdown and placed in the Docusaurus tree. Docusaurus then renders the documentation to HTML.
66+
The documentation is built with Docusaurus and the sources files are located in the [`docs/`](https://github.com/conda-forge/conda-forge.github.io/tree/main/docs) directory of the repository.
6767

6868
If you found any typo error, unclear explanations or new topics that can be covered, you can suggest changes to the documentation. For more details, please refer to [Improve the documentation](../user/contributing.md#improve-docs).
6969

docs/user/contributing.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,15 +26,15 @@ We encourage you to contribute to conda-forge. You can do so in several ways:
2626

2727
The conda-forge documentation is version-controlled in the
2828
[conda-forge.github.io repository](https://github.com/conda-forge/conda-forge.github.io) on GitHub. The source
29-
text is stored in [the sphinx/src/ subdirectory](https://github.com/conda-forge/conda-forge.github.io/tree/main/sphinx/src) of this repository and
30-
is formatted using Python's [reStructuredText](http://docutils.sourceforge.net/rst.html) system.
29+
text is stored in [the `docs/` subdirectory](https://github.com/conda-forge/conda-forge.github.io/tree/main/docs of this repository and
30+
is formatted using [Docusaurus' Markdown](https://docusaurus.io/docs/markdown-features).
3131

3232
<a id="editing-the-documentation-directly-through-github"></a>
3333

3434
### Editing the documentation directly through Github
3535

3636
You can propose quick edits directly through the GitHub website if you have
37-
a GitHub account — for instance, [this link](https://github.com/conda-forge/conda-forge.github.io/edit/main/sphinx/src/user/contributing.rst)
37+
a GitHub account — for instance, [this link](https://github.com/conda-forge/conda-forge.github.io/edit/main/docs/index.md)
3838
will take you directly to a web-based editor for this very webpage. In
3939
general, the file corresponding to each page in the GitHub browser has a
4040
little pencil icon in its top-right corner that lets you open it up for editing.

docusaurus.config.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ const config = {
2828
onBrokenAnchors: process.env.GITHUB_ACTIONS ? "throw" : "warn",
2929
favicon: "img/favicon.ico",
3030
trailingSlash: true,
31-
staticDirectories: ['static', 'static-sphinx'],
31+
staticDirectories: ['static'],
3232

3333
// GitHub pages deployment config.
3434
// If you aren't using GitHub pages, you don't need these.

src/README

Lines changed: 0 additions & 1 deletion
This file was deleted.

0 commit comments

Comments
 (0)