Comments (2)
A thought before I forget - since we're likely going to use the https://openfree.energy/ domain here, are we interested in using subdomains for the api and userguide (something like docs.openfree.energy and userguide.openfree.energy)?
Just thinking - assuming all notebooks are userguide related, we probably wouldn't need to try to move things between repos on CI or release right? We can just keep a repository_dispatch to trigger both release workflows at the same time.
from openfe.
Notebooks will be (mostly? I think?) user guide, but that doesn't mean that all user guide is 100% notebooks. Installation, for example, is a likely choice for standard RST. We might have other things (like theoretical background) that are easier to manage in RST than Jupyter.
It would be possible to maintain two sphinx repos, one for coding docs and one for user guide, but I'm not sure I see the advantage of that over just using one repo and copying in the notebooks. Moving notebooks isn't that hard; I mean, the core of getting a list of files from one github repo into a desired location is less than 10 lines of code.
Also, I think it's nice to have API in the sidebar when you're looking at user guide, and it's easier to add Sphinx links to API docs from the notebooks (and vice versa!) if they're in one repo. Sure, there's intersphinx, but....
from openfe.
Related Issues (20)
- gather tests need updating HOT 1
- add Exclusive mode error to docs
- Allow multithreading in cli test invocation HOT 1
- openff-units 0.2.1 giving typing errors
- Remove micromamba stuff from HPC docs
- Encourage properly setting residue names when building form SDF HOT 3
- Create copy of release assets (installers) without version name HOT 1
- Make toolkit registry choice optional
- CLI: Allow globs for paths HOT 2
- CLI: fetch results should untar
- Allow Openeye for charge generation HOT 9
- cli: version doesn't work on editable installs HOT 3
- cli: Protein Parameter swallows error messages HOT 1
- NES and FEP+ network ingestion HOT 1
- Tests in test_openmm_equil_rfe_protocols.py fail with pytest=7.4.0 HOT 8
- Generate network from indices will create non connected graphs if passed extra ligands HOT 4
- failed when generating RBFE network HOT 4
- RelativeHybridTopologyProtocolSettings can not round trip to JSON HOT 3
- default network_plotting doesn't produce fantastic layouts
- rdkit MolFromMol2File function assigns "wrong" tautomer, tough this seems to get corrected in the SmallMoleculeComponent
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from openfe.