Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DNM] DEMO: how site would look like with current docs #14

Closed
wants to merge 3 commits into from

Conversation

jaimergp
Copy link
Contributor

@jaimergp jaimergp commented Nov 6, 2023

Just a demo on how this would look like in the actual site.

Steps to get here:

  1. In the conda-forge.github.io site, install sphinx-markdown-builder from https://github.com/jaimergp/sphinx-markdown-builder/archive/admonitions.tar.gz
  2. Add this patch to conf.py:
diff --git a/src/conf.py b/src/conf.py
index a4daa305d..5a96a3e5b 100644
--- a/src/conf.py
+++ b/src/conf.py
@@ -36,6 +36,7 @@ extensions = [
     'sphinx.ext.todo',
     'sphinxcontrib.fulltoc',
     'sphinxcontrib.newsfeed',
+    'sphinx_markdown_builder',
 ]
 
 # Add any paths that contain templates here, relative to this directory.
  1. Build for markdown:
$ cd src
$ python -m sphinx -M markdown . _build/
  1. Run the script in this PR to move things to the right places:
$ cd cf-infra-docs/
$ python _scripts/sphinx_json_to_docusaurus.py ../conda-forge.github.io/src/_build/ docs/
  1. Some modifications in the docusaurus config.

This is NOT supposed to be merged. It's just for demonstration purposes. The actual implementation would go to conda-forge.github.io and run the steps above in CI. Source truth would still be the RST, with all the git history untouched.

Copy link

netlify bot commented Nov 6, 2023

Deploy Preview for cf-infra-docs ready!

Name Link
🔨 Latest commit acd2469
🔍 Latest deploy log https://app.netlify.com/sites/cf-infra-docs/deploys/65a8f6a4d1ba220008b98a8e
😎 Deploy Preview https://deploy-preview-14--cf-infra-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@jaimergp
Copy link
Contributor Author

@jaimergp jaimergp closed this Feb 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant