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.

Sign up for GitHub

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

Jump to bottom

Update sphinx setup for online documentation #1

Closed
valentinsulzer opened this issue Nov 6, 2018 · 1 comment
Closed

Update sphinx setup for online documentation #1

valentinsulzer opened this issue Nov 6, 2018 · 1 comment

Comments

@valentinsulzer
Copy link
Member

  • Configure sphinx to update with new documentation
  • Write how this was done for future reference
@valentinsulzer
Copy link
Member Author

How to update Sphinx docs

If file structure hasn't changed, we don't need to do anything.

If file structure has changed, first update tables of content

cd docs
sphinx-apidoc -o source ../pybamm

Then build html

make html

We could also make any stylistic changes in docs/conf.py, then build html

tlestang referenced this issue in tlestang/PyBaMM Apr 20, 2020
@tlestang
Debug parameters cli #1
2d340bd
tlestang referenced this issue in tlestang/PyBaMM Apr 20, 2020
@tlestang
Debug parameters cli #1
c07052e
tlestang referenced this issue in tlestang/PyBaMM Apr 20, 2020
@tlestang
Debug windows setup #1
4773422
tlestang pushed a commit that referenced this issue May 14, 2020
@dalonsoa
Merge pull request #1 from dalonsoa/github_ci
40ddcf2 
Add GitHub CI
valentinsulzer pushed a commit that referenced this issue Jun 23, 2020
@felipe-salinas
Merge pull request #1 from pybamm-team/develop
49a490c 
Merge develop
valentinsulzer pushed a commit that referenced this issue Sep 16, 2020
@tlestang
Merge pull request #1 from tlestang/develop
d5251d3 
Test automated build and delployment
@DrSOKane DrSOKane mentioned this issue Feb 3, 2021
Closed
martinjrobins added a commit that referenced this issue May 5, 2022
@martinjrobins
#1 try match pyhton and pip
c25d5fe
valentinsulzer pushed a commit that referenced this issue Mar 8, 2023
@agriyakhetarpal
Merge pull request #1 from mre/patch-1
961a12f 
Move lychee args to correct position
juliawind pushed a commit to juliawind/PyBaMMj that referenced this issue Mar 29, 2023
@amirDahari1
Merge pull request pybamm-team#1 from tldr-group/log-efficiency
3663de4 
log transport efficiency
jonchapman1 pushed a commit to jonchapman1/PyBaMM_SJC that referenced this issue Mar 29, 2023
@RuiheLi
Merge pull request pybamm-team#1 from mbonkile/Exp
4e5e4bc 
Exp
@mpegis mpegis mentioned this issue May 17, 2023
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@valentinsulzer