Updated the instructions to build docs locally #6835
Conversation
|
|
||
| $ pip install sphinx~=1.3.0 git+https://github.com/fabpot/sphinx-php.git | ||
|
|
||
| **Step 3.** Run ``make html`` and view the generated documentation in the |
There was a problem hiding this comment.
It should be mentioned that make html has to be run inside the _build dir as the Makefile has been moved.
There was a problem hiding this comment.
Nice catch! Thank you. I've reworded this a bit in a7b4d32.
|
👍 Status: Reviewed |
|
|
||
| $ pip install sphinx~=1.3.0 git+https://github.com/fabpot/sphinx-php.git | ||
|
|
||
| **Step 3.** Run the following command to build the documentation in HTML format: |
|
I've tried this in Windows and not work for me :/ ... and the path ❓ |
|
@yceruto the error seems to be in this line: |
|
|
|
|
||
| .. code-block:: bash | ||
|
|
||
| $ _build\make html |
There was a problem hiding this comment.
on Unix, it should be ./_build/make html IIRC
There was a problem hiding this comment.
Maybe this part should be split in two sections ? Unix and Windows ?
|
@wouterj On the other hand, inside
this not work offline, any solution ? |
|
The same for all *.svg paths inside |
|
I just created a separate issue for these questions, because they are out of scope of this PR. #6844 |
| ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
|
|
||
| Alternatively you can build the documentation in your own computer following | ||
| these steps: |
There was a problem hiding this comment.
To be honest, I was confused in thinking that could build the documentation locally and use it completely "offline", which it's not possible right now and probably never will #6844 (comment). Maybe we can add the subject "only for testing purpose" somehow? The previous title/description it was clearer in this sense, thanks.
|
👍 |
| Build the Documentation Locally | ||
| ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
|
|
||
| Alternatively you can build the documentation in your own computer for testing |
|
Thanks Javier! |
…iluz) This PR was merged into the 2.7 branch. Discussion ---------- Updated the instructions to build docs locally This finishes #6395. Commits ------- a2428a4 Minor improvements 914dd30 Fixed the "make" command 77c88bf Fixed again the tricky list syntax 767b49b Fixed the syntax of the list c71ad4b Minor fixes a7b4d32 Reword the third step cebc382 Added the missing link references 348b11c Updated the instructions to build docs locally
This finishes #6395.